Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sources): update documentation #845

Merged
merged 1 commit into from
Jan 24, 2024

Conversation

aws-cdk-automation
Copy link
Contributor

⚠️ This Pull Request updates daily and will overwrite all manual changes pushed to the branch

Updates the documentation source from upstream. See details in workflow run.


Automatically created by projen via the "update-source-documentation" workflow

> ⚠️ This Pull Request updates daily and will overwrite **all** manual changes pushed to the branch

Updates the documentation source from upstream. See details in [workflow run].

[Workflow Run]: https://github.com/cdklabs/awscdk-service-spec/actions/runs/7635058367

------

*Automatically created by projen via the "update-source-documentation" workflow*

Signed-off-by: github-actions <[email protected]>
Copy link

To work on this Pull Request, please create a new branch and PR. This prevents your work from being deleted by the automation.

Run the following commands inside the repo:

gh co 845
git switch -c fix-pr-845 && git push -u origin HEAD
gh pr create -t "fix: PR #845" --body "Fixes https://github.com/cdklabs/awscdk-service-spec/pull/845"

Copy link

@aws-cdk/aws-service-spec: Model database diff detected

├[~] service aws-cloud9
│ └ resources
│    └[~] resource AWS::Cloud9::EnvironmentEC2
│      └ properties
│         └ ImageId: (documentation changed)
├[~] service aws-cloudtrail
│ └ resources
│    ├[~] resource AWS::CloudTrail::EventDataStore
│    │ └ types
│    │    └[~] type AdvancedEventSelector
│    │      └  - documentation: Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
│    │         - `readOnly`
│    │         - `eventSource`
│    │         - `eventName`
│    │         - `eventCategory`
│    │         - `resources.type`
│    │         - `resources.ARN`
│    │         You cannot apply both event selectors and advanced event selectors to a trail.
│    │         + documentation: Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) and [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
│    │         You cannot apply both event selectors and advanced event selectors to a trail.
│    │         *Supported CloudTrail event record fields for management events*
│    │         - `eventCategory` (required)
│    │         - `eventSource`
│    │         - `readOnly`
│    │         *Supported CloudTrail event record fields for data events*
│    │         - `eventCategory` (required)
│    │         - `resources.type` (required)
│    │         - `readOnly`
│    │         - `eventName`
│    │         - `resources.ARN`
│    │         > For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is `eventCategory` .
│    └[~] resource AWS::CloudTrail::Trail
│      └ types
│         └[~] type AdvancedEventSelector
│           └  - documentation: Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
│              - `readOnly`
│              - `eventSource`
│              - `eventName`
│              - `eventCategory`
│              - `resources.type`
│              - `resources.ARN`
│              You cannot apply both event selectors and advanced event selectors to a trail.
│              + documentation: Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) and [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
│              You cannot apply both event selectors and advanced event selectors to a trail.
│              *Supported CloudTrail event record fields for management events*
│              - `eventCategory` (required)
│              - `eventSource`
│              - `readOnly`
│              *Supported CloudTrail event record fields for data events*
│              - `eventCategory` (required)
│              - `resources.type` (required)
│              - `readOnly`
│              - `eventName`
│              - `resources.ARN`
│              > For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is `eventCategory` .
├[~] service aws-codebuild
│ └ resources
│    └[~] resource AWS::CodeBuild::Fleet
│      ├  - documentation: Resource Type definition for AWS::CodeBuild::Fleet
│      │  + documentation: The `AWS::CodeBuild::Fleet` resource configures a compute fleet, a set of dedicated instances for your build environment.
│      ├ properties
│      │  ├ BaseCapacity: (documentation changed)
│      │  ├ ComputeType: (documentation changed)
│      │  ├ EnvironmentType: (documentation changed)
│      │  ├ Name: (documentation changed)
│      │  └ Tags: (documentation changed)
│      └ attributes
│         └ Arn: (documentation changed)
├[~] service aws-datasync
│ └ resources
│    └[~] resource AWS::DataSync::LocationS3
│      ├ properties
│      │  ├ Subdirectory: (documentation changed)
│      │  └ Tags: (documentation changed)
│      └ types
│         └[~] type S3Config
│           ├  - documentation: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to access an Amazon S3 bucket.
│           │  For detailed information about using such a role, see [Creating a Location for Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html) in the *AWS DataSync User Guide* .
│           │  + documentation: Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
│           │  For more information, see [Accessing S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) .
│           └ properties
│              └ BucketAccessRoleArn: (documentation changed)
├[~] service aws-ecs
│ └ resources
│    └[~] resource AWS::ECS::Service
│      └ types
│         ├[~] type ServiceConnectService
│         │ └ properties
│         │    └ Timeout: (documentation changed)
│         ├[~] type ServiceConnectTlsCertificateAuthority
│         │ ├  - documentation: undefined
│         │ │  + documentation: An object that represents the AWS Private Certificate Authority certificate.
│         │ └ properties
│         │    └ AwsPcaAuthorityArn: (documentation changed)
│         ├[~] type ServiceConnectTlsConfiguration
│         │ ├  - documentation: undefined
│         │ │  + documentation: An object that represents the configuration for Service Connect TLS.
│         │ └ properties
│         │    ├ IssuerCertificateAuthority: (documentation changed)
│         │    ├ KmsKey: (documentation changed)
│         │    └ RoleArn: (documentation changed)
│         └[~] type TimeoutConfiguration
│           ├  - documentation: undefined
│           │  + documentation: An object that represents the timeout configurations for Service Connect.
│           │  > If `idleTimeout` is set to a time that is less than `perRequestTimeout` , the connection will close when the `idleTimeout` is reached and not the `perRequestTimeout` .
│           └ properties
│              ├ IdleTimeoutSeconds: (documentation changed)
│              └ PerRequestTimeoutSeconds: (documentation changed)
├[~] service aws-internetmonitor
│ └ resources
│    └[~] resource AWS::InternetMonitor::Monitor
│      └ types
│         ├[~] type InternetMeasurementsLogDelivery
│         │ └ properties
│         │    └ S3Config: (documentation changed)
│         └[~] type S3Config
│           ├  - documentation: The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` if you choose to deliver internet measurements to S3 logs, and `DISABLED` otherwise.
│           │  The measurements are also published to Amazon CloudWatch Logs.
│           │  + documentation: The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` or `DISABLED` , depending on whether you choose to deliver internet measurements to S3 logs.
│           └ properties
│              ├ BucketName: (documentation changed)
│              ├ BucketPrefix: (documentation changed)
│              └ LogDeliveryStatus: (documentation changed)
├[~] service aws-networkmanager
│ └ resources
│    └[~] resource AWS::NetworkManager::Device
│      └ attributes
│         └ CreatedAt: (documentation changed)
├[~] service aws-rolesanywhere
│ └ resources
│    ├[~] resource AWS::RolesAnywhere::Profile
│    │ ├  - documentation: Creates a Profile.
│    │ │  + documentation: Creates a *profile* , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
│    │ │  *Required permissions:* `rolesanywhere:CreateProfile` .
│    │ └ properties
│    │    ├ DurationSeconds: (documentation changed)
│    │    ├ Enabled: (documentation changed)
│    │    ├ ManagedPolicyArns: (documentation changed)
│    │    ├ Name: (documentation changed)
│    │    ├ RequireInstanceProperties: (documentation changed)
│    │    ├ RoleArns: (documentation changed)
│    │    ├ SessionPolicy: (documentation changed)
│    │    └ Tags: (documentation changed)
│    └[~] resource AWS::RolesAnywhere::TrustAnchor
│      ├  - documentation: Creates a TrustAnchor.
│      │  + documentation: Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an AWS Private Certificate Authority ( AWS Private CA ) or by uploading a CA certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary AWS credentials.
│      │  *Required permissions:* `rolesanywhere:CreateTrustAnchor` .
│      └ types
│         ├[~] type Source
│         │ ├  - documentation: Object representing the TrustAnchor type and its related certificate data.
│         │ │  + documentation: The trust anchor type and its related certificate data.
│         │ └ properties
│         │    ├ SourceData: (documentation changed)
│         │    └ SourceType: (documentation changed)
│         └[~] type SourceData
│           └  - documentation: A union object representing the data field of the TrustAnchor depending on its type
│              + documentation: The data field of the trust anchor depending on its type.
├[~] service aws-route53
│ └ resources
│    └[~] resource AWS::Route53::RecordSetGroup
│      └ attributes
│         └ Id: (documentation changed)
└[~] service aws-transfer
  └ resources
     └[~] resource AWS::Transfer::Connector
       └ types
          └[~] type SftpConfig
            └ properties
               └ TrustedHostKeys: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Jan 24, 2024
Merged via the queue into main with commit 446d977 Jan 24, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch January 24, 2024 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant