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 #661

Merged
merged 1 commit into from
Nov 2, 2023

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/6727886132

------

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

Signed-off-by: github-actions <github-actions@github.com>
Copy link

github-actions bot commented Nov 2, 2023

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 661
git switch -c fix-pr-661 && git push -u origin HEAD
gh pr create -t "fix: PR #661" --body "Fixes https://github.com/cdklabs/awscdk-service-spec/pull/661"

Copy link

github-actions bot commented Nov 2, 2023

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

├[~] service aws-amplify
│ └ resources
│    └[~] resource AWS::Amplify::Branch
│      ├ properties
│      │  └ Backend: (documentation changed)
│      └ types
│         └[~] type Backend
│           ├  - documentation: undefined
│           │  + documentation: Describes the backend properties associated with an Amplify `Branch` .
│           └ properties
│              └ StackArn: (documentation changed)
├[~] service aws-config
│ └ resources
│    └[~] resource AWS::Config::ConfigurationRecorder
│      └ types
│         ├[~] type ExclusionByResourceTypes
│         │ └  - documentation: Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the `resourceTypes` field to enter a comma-separated list of resource types you want to exclude from recording.
│         │    By default, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically.
│         │    > *How to use*
│         │    > 
│         │    > To use this option, you must set the `useOnly` field of [AWS::Config::ConfigurationRecorder RecordingStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html) to `EXCLUSION_BY_RESOURCE_TYPES` .
│         │    > 
│         │    > AWS Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.
│         │    > 
│         │    > *Globally recorded resources*
│         │    > 
│         │    > Unless specifically listed as exclusions, `AWS::RDS::GlobalCluster` will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled AWS Config Regions where AWS Config was available before February 2022. This list does not include the following Regions:
│         │    > 
│         │    > - Asia Pacific (Hyderabad)
│         │    > - Asia Pacific (Melbourne)
│         │    > - Europe (Spain)
│         │    > - Europe (Zurich)
│         │    > - Israel (Tel Aviv)
│         │    > - Middle East (UAE)
│         │    + documentation: Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the `resourceTypes` field to enter a comma-separated list of resource types you want to exclude from recording.
│         │    By default, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically.
│         │    > *How to use the exclusion recording strategy*
│         │    > 
│         │    > To use this option, you must set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `EXCLUSION_BY_RESOURCE_TYPES` .
│         │    > 
│         │    > AWS Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.
│         │    > 
│         │    > *Global resource types and the exclusion recording strategy*
│         │    > 
│         │    > Unless specifically listed as exclusions, `AWS::RDS::GlobalCluster` will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled.
│         │    > 
│         │    > IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:
│         │    > 
│         │    > - Asia Pacific (Hyderabad)
│         │    > - Asia Pacific (Melbourne)
│         │    > - Europe (Spain)
│         │    > - Europe (Zurich)
│         │    > - Israel (Tel Aviv)
│         │    > - Middle East (UAE)
│         ├[~] type RecordingGroup
│         │ ├  - documentation: Specifies which resource types AWS Config records for configuration changes. By default, AWS Config records configuration changes for all current and future supported resource types in the AWS Region where you have enabled AWS Config (excluding the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies).
│         │ │  In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see [Supported Resource Types](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) in the *AWS Config developer guide* .
│         │ │  If you don't want AWS Config to record all current and future supported resource types, use one of the following recording strategies:
│         │ │  - *Record all current and future resource types with exclusions* ( `EXCLUSION_BY_RESOURCE_TYPES` ), or
│         │ │  - *Record specific resource types* ( `INCLUSION_BY_RESOURCE_TYPES` ).
│         │ │  > *Aurora global clusters are automatically globally recorded*
│         │ │  > 
│         │ │  > The `AWS::RDS::GlobalCluster` resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled.
│         │ │  > 
│         │ │  > If you do not want to record `AWS::RDS::GlobalCluster` in all enabled Regions, use the `EXCLUSION_BY_RESOURCE_TYPES` or `INCLUSION_BY_RESOURCE_TYPES` recording strategy.
│         │ │  + documentation: Specifies which resource types AWS Config records for configuration changes. By default, AWS Config records configuration changes for all current and future supported resource types in the AWS Region where you have enabled AWS Config , excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.
│         │ │  In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see [Supported Resource Types](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) in the *AWS Config developer guide* .
│         │ │  If you don't want AWS Config to record all current and future supported resource types (excluding the global IAM resource types), use one of the following recording strategies:
│         │ │  - *Record all current and future resource types with exclusions* ( `EXCLUSION_BY_RESOURCE_TYPES` ), or
│         │ │  - *Record specific resource types* ( `INCLUSION_BY_RESOURCE_TYPES` ).
│         │ │  If you use the recording strategy to *Record all current and future resource types* ( `ALL_SUPPORTED_RESOURCE_TYPES` ), you can use the flag `includeGlobalResourceTypes` to include the global IAM resource types in your recording.
│         │ │  > *Aurora global clusters are recorded in all enabled Regions*
│         │ │  > 
│         │ │  > The `AWS::RDS::GlobalCluster` resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled.
│         │ │  > 
│         │ │  > If you do not want to record `AWS::RDS::GlobalCluster` in all enabled Regions, use the `EXCLUSION_BY_RESOURCE_TYPES` or `INCLUSION_BY_RESOURCE_TYPES` recording strategy.
│         │ └ properties
│         │    ├ IncludeGlobalResourceTypes: (documentation changed)
│         │    ├ RecordingStrategy: (documentation changed)
│         │    └ ResourceTypes: (documentation changed)
│         └[~] type RecordingStrategy
│           └ properties
│              └ UseOnly: (documentation changed)
├[~] service aws-gamelift
│ └ resources
│    └[~] resource AWS::GameLift::Build
│      └ properties
│         └ ServerSdkVersion: (documentation changed)
├[~] service aws-lakeformation
│ └ resources
│    ├[~] resource AWS::LakeFormation::Permissions
│    │ ├ attributes
│    │ │  └ Id: (documentation changed)
│    │ └ types
│    │    └[~] type TableWildcard
│    │      └  - documentation: A wildcard object representing every table under a database.
│    │         + documentation: undefined
│    └[~] resource AWS::LakeFormation::PrincipalPermissions
│      └ types
│         └[~] type TableResource
│           └ properties
│              └ CatalogId: (documentation changed)
├[~] service aws-networkmanager
│ └ resources
│    └[~] resource AWS::NetworkManager::Device
│      └ attributes
│         └ CreatedAt: (documentation changed)
└[~] service aws-pinpoint
  └ resources
     ├[~] resource AWS::Pinpoint::ADMChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::APNSChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::APNSSandboxChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::APNSVoipChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::APNSVoipSandboxChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::App
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::ApplicationSettings
     │ └ properties
     │    └ CloudWatchMetricsEnabled: (documentation changed)
     ├[~] resource AWS::Pinpoint::BaiduChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::Campaign
     │ ├ properties
     │ │  ├ MessageConfiguration: (documentation changed)
     │ │  ├ Schedule: (documentation changed)
     │ │  ├ TreatmentDescription: (documentation changed)
     │ │  └ TreatmentName: (documentation changed)
     │ └ types
     │    ├[~] type AttributeDimension
     │    │ ├  - documentation: Specifies attribute-based criteria for including or excluding endpoints from a segment.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ AttributeType: (documentation changed)
     │    │    └ Values: (documentation changed)
     │    └[~] type MetricDimension
     │      ├  - documentation: Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
     │      │  + documentation: undefined
     │      └ properties
     │         ├ ComparisonOperator: (documentation changed)
     │         └ Value: (documentation changed)
     ├[~] resource AWS::Pinpoint::EmailChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::GCMChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::PushTemplate
     │ └ properties
     │    └ TemplateName: (documentation changed)
     ├[~] resource AWS::Pinpoint::Segment
     │ ├ properties
     │ │  └ Dimensions: (documentation changed)
     │ └ types
     │    └[~] type AttributeDimension
     │      ├  - documentation: Specifies attribute-based criteria for including or excluding endpoints from a segment.
     │      │  + documentation: undefined
     │      └ properties
     │         ├ AttributeType: (documentation changed)
     │         └ Values: (documentation changed)
     ├[~] resource AWS::Pinpoint::SMSChannel
     │ └ attributes
     │    └ Id: (documentation changed)
     ├[~] resource AWS::Pinpoint::SmsTemplate
     │ └ properties
     │    └ TemplateName: (documentation changed)
     └[~] resource AWS::Pinpoint::VoiceChannel
       └ attributes
          └ Id: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Nov 2, 2023
Merged via the queue into main with commit 81cb5c8 Nov 2, 2023
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch November 2, 2023 03:40
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