cdk-common 2.0.404 → 2.0.406
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/main.js +1 -1
- package/node_modules/@aws-cdk/assert/package.json +8 -8
- package/node_modules/@aws-cdk/cfnspec/CHANGELOG.md +139 -0
- package/node_modules/@aws-cdk/cfnspec/package.json +3 -3
- package/node_modules/@aws-cdk/cfnspec/spec/cfn-docs.json +772 -329
- package/node_modules/@aws-cdk/cfnspec/spec/specification.json +1494 -66
- package/node_modules/@aws-cdk/cloudformation-diff/package.json +4 -4
- package/package.json +3 -3
|
@@ -1931,7 +1931,7 @@
|
|
|
1931
1931
|
"properties": {
|
|
1932
1932
|
"ApplicationId": "The application ID.",
|
|
1933
1933
|
"Description": "A description of the configuration profile.",
|
|
1934
|
-
"LocationUri": "A URI to locate the configuration. You can specify the
|
|
1934
|
+
"LocationUri": "A URI to locate the configuration. You can specify the following:\n\n- For the AWS AppConfig hosted configuration store and for feature flags, specify `hosted` .\n- For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://<parameter name>` or the ARN.\n- For an AWS Secrets Manager secret, specify the URI in the following format: `secrets-manager` ://<secret name>.\n- For an Amazon S3 object, specify the URI in the following format: `s3://<bucket>/<objectKey>` . Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json`\n- For an SSM document, specify either the document name in the format `ssm-document://<document name>` or the Amazon Resource Name (ARN).",
|
|
1935
1935
|
"Name": "A name for the configuration profile.",
|
|
1936
1936
|
"RetrievalRoleArn": "The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .\n\n> A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.",
|
|
1937
1937
|
"Tags": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.",
|
|
@@ -4841,14 +4841,14 @@
|
|
|
4841
4841
|
"Description": "The description of the data source.",
|
|
4842
4842
|
"DynamoDBConfig": "AWS Region and TableName for an Amazon DynamoDB table in your account.",
|
|
4843
4843
|
"ElasticsearchConfig": "AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.\n\nAs of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use *OpenSearchServiceConfig* to specify an OpenSearch Service data source.",
|
|
4844
|
-
"EventBridgeConfig": "",
|
|
4844
|
+
"EventBridgeConfig": "An EventBridge configuration that contains a valid ARN of an event bus.",
|
|
4845
4845
|
"HttpConfig": "Endpoints for an HTTP data source.",
|
|
4846
4846
|
"LambdaConfig": "An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account.",
|
|
4847
4847
|
"Name": "Friendly name for you to identify your AppSync data source after creation.",
|
|
4848
4848
|
"OpenSearchServiceConfig": "AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.",
|
|
4849
4849
|
"RelationalDatabaseConfig": "Relational Database configuration of the relational database data source.",
|
|
4850
|
-
"ServiceRoleArn": "The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.\n\nRequired if `Type` is specified as `AWS_LAMBDA` , `AMAZON_DYNAMODB` , `AMAZON_ELASTICSEARCH` , or `AMAZON_OPENSEARCH_SERVICE` .",
|
|
4851
|
-
"Type": "The type of the data source.\n\n- *AWS_LAMBDA* : The data source is an AWS Lambda function.\n- *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table.\n- *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain.\n- *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain.\n- *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.\n- *HTTP* : The data source is an HTTP endpoint.\n- *RELATIONAL_DATABASE* : The data source is a relational database."
|
|
4850
|
+
"ServiceRoleArn": "The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.\n\nRequired if `Type` is specified as `AWS_LAMBDA` , `AMAZON_DYNAMODB` , `AMAZON_ELASTICSEARCH` , `AMAZON_EVENTBRIDGE` , or `AMAZON_OPENSEARCH_SERVICE` .",
|
|
4851
|
+
"Type": "The type of the data source.\n\n- *AWS_LAMBDA* : The data source is an AWS Lambda function.\n- *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table.\n- *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain.\n- *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus.\n- *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain.\n- *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.\n- *HTTP* : The data source is an HTTP endpoint.\n- *RELATIONAL_DATABASE* : The data source is a relational database."
|
|
4852
4852
|
}
|
|
4853
4853
|
},
|
|
4854
4854
|
"AWS::AppSync::DataSource.AuthorizationConfig": {
|
|
@@ -4897,9 +4897,9 @@
|
|
|
4897
4897
|
},
|
|
4898
4898
|
"AWS::AppSync::DataSource.EventBridgeConfig": {
|
|
4899
4899
|
"attributes": {},
|
|
4900
|
-
"description": "",
|
|
4900
|
+
"description": "The data source. This can be an API destination, resource, or AWS service.",
|
|
4901
4901
|
"properties": {
|
|
4902
|
-
"EventBusArn": ""
|
|
4902
|
+
"EventBusArn": "The event bus pipeline's ARN. For more information about event buses, see [EventBridge event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html) ."
|
|
4903
4903
|
}
|
|
4904
4904
|
},
|
|
4905
4905
|
"AWS::AppSync::DataSource.HttpConfig": {
|
|
@@ -5591,7 +5591,7 @@
|
|
|
5591
5591
|
"AssessmentName": "The name of the assessment that's associated with the delegation.",
|
|
5592
5592
|
"Comment": "The comment that's related to the delegation.",
|
|
5593
5593
|
"ControlSetId": "The identifier for the control set that's associated with the delegation.",
|
|
5594
|
-
"CreatedBy": "The
|
|
5594
|
+
"CreatedBy": "The user or role that created the delegation.\n\n*Minimum* : `1`\n\n*Maximum* : `100`\n\n*Pattern* : `^[a-zA-Z0-9-_()\\\\[\\\\]\\\\s]+$`",
|
|
5595
5595
|
"CreationTime": "Specifies when the delegation was created.",
|
|
5596
5596
|
"Id": "The unique identifier for the delegation.",
|
|
5597
5597
|
"LastUpdated": "Specifies when the delegation was last updated.",
|
|
@@ -8558,6 +8558,37 @@
|
|
|
8558
8558
|
"Enabled": "This field is `true` if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is `false` ."
|
|
8559
8559
|
}
|
|
8560
8560
|
},
|
|
8561
|
+
"AWS::CloudTrail::Channel": {
|
|
8562
|
+
"attributes": {
|
|
8563
|
+
"ChannelArn": "`Ref` returns the ARN of the CloudTrail channel, such as `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890` .",
|
|
8564
|
+
"Channels": "`Ref` returns the names of CloudTrail channels.",
|
|
8565
|
+
"Ref": "When the logical ID of this resource is provided to the Ref intrinsic function, `Ref` returns the resource name."
|
|
8566
|
+
},
|
|
8567
|
+
"description": "Contains information about a returned CloudTrail channel.",
|
|
8568
|
+
"properties": {
|
|
8569
|
+
"Channel": "Contains information about a returned CloudTrail channel.",
|
|
8570
|
+
"Destinations": "One or more event data stores to which events arriving through a channel will be logged.",
|
|
8571
|
+
"Name": "The name of the channel.",
|
|
8572
|
+
"Source": "The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.\n\nA source can be either `Custom` for all valid non- AWS events, or the name of a partner event source. For information about the source names for available partners, see [Additional information about integration partners](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) in the CloudTrail User Guide.",
|
|
8573
|
+
"Tags": "A list of tags."
|
|
8574
|
+
}
|
|
8575
|
+
},
|
|
8576
|
+
"AWS::CloudTrail::Channel.Channel": {
|
|
8577
|
+
"attributes": {},
|
|
8578
|
+
"description": "Contains information about a returned CloudTrail channel.",
|
|
8579
|
+
"properties": {
|
|
8580
|
+
"ChannelArn": "The Amazon Resource Name (ARN) of a channel.",
|
|
8581
|
+
"Name": "The name of the CloudTrail channel. For service-linked channels, the name is `aws-service-channel/service-name/custom-suffix` where `service-name` represents the name of the AWS service that created the channel and `custom-suffix` represents the suffix created by the AWS service."
|
|
8582
|
+
}
|
|
8583
|
+
},
|
|
8584
|
+
"AWS::CloudTrail::Channel.Destination": {
|
|
8585
|
+
"attributes": {},
|
|
8586
|
+
"description": "Contains information about the destination receiving events.",
|
|
8587
|
+
"properties": {
|
|
8588
|
+
"Location": "For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the AWS service.",
|
|
8589
|
+
"Type": "The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is `EventDataStore` . For service-linked channels, the value is `AWS_SERVICE` ."
|
|
8590
|
+
}
|
|
8591
|
+
},
|
|
8561
8592
|
"AWS::CloudTrail::EventDataStore": {
|
|
8562
8593
|
"attributes": {
|
|
8563
8594
|
"CreatedTimestamp": "`Ref` returns the time stamp of the creation of the event data store, such as `1248496624` .",
|
|
@@ -8568,7 +8599,7 @@
|
|
|
8568
8599
|
},
|
|
8569
8600
|
"description": "Creates a new event data store.",
|
|
8570
8601
|
"properties": {
|
|
8571
|
-
"AdvancedEventSelectors": "The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.\n\nFor more information about how to use advanced event selectors to log CloudTrail events, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide.\n\nFor more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-cli-create-eds-config.html) in the CloudTrail User Guide.",
|
|
8602
|
+
"AdvancedEventSelectors": "The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.\n\nFor more information about how to use advanced event selectors to log CloudTrail events, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide.\n\nFor more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide.\n\nFor more information about how to use advanced event selectors to include non- AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) in the CloudTrail User Guide.",
|
|
8572
8603
|
"KmsKeyId": "Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by `alias/` , a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.\n\n> Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store. \n\nCloudTrail also supports AWS KMS multi-Region keys. For more information about multi-Region keys, see [Using multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .\n\nExamples:\n\n- `alias/MyAliasName`\n- `arn:aws:kms:us-east-2:123456789012:alias/MyAliasName`\n- `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`\n- `12345678-1234-1234-1234-123456789012`",
|
|
8573
8604
|
"MultiRegionEnabled": "Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.",
|
|
8574
8605
|
"Name": "The name of the event data store.",
|
|
@@ -8592,13 +8623,23 @@
|
|
|
8592
8623
|
"properties": {
|
|
8593
8624
|
"EndsWith": "An operator that includes events that match the last few characters of the event record field specified as the value of `Field` .",
|
|
8594
8625
|
"Equals": "An operator that includes events that match the exact value of the event record field specified as the value of `Field` . This is the only valid operator that you can use with the `readOnly` , `eventCategory` , and `resources.type` fields.",
|
|
8595
|
-
"Field": "A field in a CloudTrail event record on which to filter events to be logged. For event data stores for AWS Config configuration items, the field is used only for selecting
|
|
8626
|
+
"Field": "A field in a CloudTrail event record on which to filter events to be logged. For event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, the field is used only for selecting events as filtering is not supported.\n\nFor CloudTrail event records, supported fields include `readOnly` , `eventCategory` , `eventSource` (for management events), `eventName` , `resources.type` , and `resources.ARN` .\n\nFor event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, the only supported field is `eventCategory` .\n\n- *`readOnly`* - Optional. Can be set to `Equals` a value of `true` or `false` . If you do not add this field, CloudTrail logs both `read` and `write` events. A value of `true` logs only `read` events. A value of `false` logs only `write` events.\n- *`eventSource`* - For filtering management events only. This can be set only to `NotEquals` `kms.amazonaws.com` .\n- *`eventName`* - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock` . You can have multiple values for this field, separated by commas.\n- *`eventCategory`* - This is required and must be set to `Equals` .\n\n- For CloudTrail event records, the value must be `Management` or `Data` .\n- For AWS Config configuration items, the value must be `ConfigurationItem` .\n- For Audit Manager evidence, the value must be `Evidence` .\n- For non- AWS events, the value must be `ActivityAuditLog` .\n- *`resources.type`* - This field is required for CloudTrail data events. `resources.type` can only use the `Equals` operator, and the value can be one of the following:\n\n- `AWS::CloudTrail::Channel`\n- `AWS::S3::Object`\n- `AWS::Lambda::Function`\n- `AWS::DynamoDB::Table`\n- `AWS::S3Outposts::Object`\n- `AWS::ManagedBlockchain::Node`\n- `AWS::S3ObjectLambda::AccessPoint`\n- `AWS::EC2::Snapshot`\n- `AWS::S3::AccessPoint`\n- `AWS::DynamoDB::Stream`\n- `AWS::Glue::Table`\n- `AWS::FinSpace::Environment`\n- `AWS::SageMaker::ExperimentTrialComponent`\n- `AWS::SageMaker::FeatureGroup`\n\nYou can have only one `resources.type` field per selector. To log data events on more than one resource type, add another selector.\n- *`resources.ARN`* - You can use any operator with `resources.ARN` , but if you use `Equals` or `NotEquals` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals `AWS::S3::Object` , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the `StartsWith` operator, and include only the bucket ARN as the matching value.\n\nThe trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.\n\n- `arn:<partition>:s3:::<bucket_name>/`\n- `arn:<partition>:s3:::<bucket_name>/<object_path>/`\n\nWhen `resources.type` equals `AWS::S3::AccessPoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the `StartsWith` or `NotStartsWith` operators.\n\n- `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>`\n- `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>`\n\nWhen resources.type equals `AWS::Lambda::Function` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>`\n\nWhen resources.type equals `AWS::DynamoDB::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>`\n\nWhen resources.type equals `AWS::CloudTrail::Channel` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>`\n\nWhen `resources.type` equals `AWS::S3Outposts::Object` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>`\n\nWhen `resources.type` equals `AWS::ManagedBlockchain::Node` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>`\n\nWhen `resources.type` equals `AWS::S3ObjectLambda::AccessPoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>`\n\nWhen `resources.type` equals `AWS::EC2::Snapshot` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>`\n\nWhen `resources.type` equals `AWS::DynamoDB::Stream` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>`\n\nWhen `resources.type` equals `AWS::Glue::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>`\n\nWhen `resources.type` equals `AWS::FinSpace::Environment` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>`\n\nWhen `resources.type` equals `AWS::SageMaker::ExperimentTrialComponent` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>`\n\nWhen `resources.type` equals `AWS::SageMaker::FeatureGroup` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format:\n\n- `arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>`",
|
|
8596
8627
|
"NotEndsWith": "An operator that excludes events that match the last few characters of the event record field specified as the value of `Field` .",
|
|
8597
8628
|
"NotEquals": "An operator that excludes events that match the exact value of the event record field specified as the value of `Field` .",
|
|
8598
8629
|
"NotStartsWith": "An operator that excludes events that match the first few characters of the event record field specified as the value of `Field` .",
|
|
8599
8630
|
"StartsWith": "An operator that includes events that match the first few characters of the event record field specified as the value of `Field` ."
|
|
8600
8631
|
}
|
|
8601
8632
|
},
|
|
8633
|
+
"AWS::CloudTrail::ResourcePolicy": {
|
|
8634
|
+
"attributes": {
|
|
8635
|
+
"Ref": "When the logical ID of this resource is provided to the Ref intrinsic function, `Ref` returns the resource. The resource is a combination of the resource-based policy document and the channel ARN."
|
|
8636
|
+
},
|
|
8637
|
+
"description": "Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of AWS . For more information about resource-based policies, see [CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) in the *CloudTrail User Guide* .",
|
|
8638
|
+
"properties": {
|
|
8639
|
+
"ResourceArn": "The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is the format of a resource ARN: `arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel` .",
|
|
8640
|
+
"ResourcePolicy": "A JSON-formatted string for an AWS resource-based policy.\n\nThe following are requirements for the resource policy:\n\n- Contains only one action: cloudtrail-data:PutAuditEvents\n- Contains at least one statement. The policy can have a maximum of 20 statements.\n- Each statement contains at least one principal. A statement can have a maximum of 50 principals."
|
|
8641
|
+
}
|
|
8642
|
+
},
|
|
8602
8643
|
"AWS::CloudTrail::Trail": {
|
|
8603
8644
|
"attributes": {
|
|
8604
8645
|
"Arn": "`Ref` returns the ARN of the CloudTrail trail, such as `arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail` .",
|
|
@@ -10706,10 +10747,10 @@
|
|
|
10706
10747
|
"attributes": {
|
|
10707
10748
|
"Ref": ""
|
|
10708
10749
|
},
|
|
10709
|
-
"description": "",
|
|
10750
|
+
"description": "The approved origin for the instance.",
|
|
10710
10751
|
"properties": {
|
|
10711
|
-
"InstanceId": "",
|
|
10712
|
-
"Origin": ""
|
|
10752
|
+
"InstanceId": "The Amazon Resource Name (ARN) of the instance.\n\n*Minimum* : `1`\n\n*Maximum* : `100`",
|
|
10753
|
+
"Origin": "Domain name to be added to the allow-list of the instance.\n\n*Maximum* : `267`"
|
|
10713
10754
|
}
|
|
10714
10755
|
},
|
|
10715
10756
|
"AWS::Connect::ContactFlow": {
|
|
@@ -10864,14 +10905,14 @@
|
|
|
10864
10905
|
},
|
|
10865
10906
|
"AWS::Connect::IntegrationAssociation": {
|
|
10866
10907
|
"attributes": {
|
|
10867
|
-
"IntegrationAssociationId": "",
|
|
10908
|
+
"IntegrationAssociationId": "Identifier of the association with an Amazon Connect instance.",
|
|
10868
10909
|
"Ref": ""
|
|
10869
10910
|
},
|
|
10870
|
-
"description": "
|
|
10911
|
+
"description": "Specifies the association of an AWS resource such as Lex bot (both v1 and v2) and Lambda function with an Amazon Connect instance.",
|
|
10871
10912
|
"properties": {
|
|
10872
|
-
"InstanceId": "The
|
|
10873
|
-
"IntegrationArn": "
|
|
10874
|
-
"IntegrationType": "
|
|
10913
|
+
"InstanceId": "The Amazon Resource Name (ARN) of the instance.\n\n*Minimum* : `1`\n\n*Maximum* : `100`",
|
|
10914
|
+
"IntegrationArn": "ARN of the integration being associated with the instance.\n\n*Minimum* : `1`\n\n*Maximum* : `140`",
|
|
10915
|
+
"IntegrationType": "Specifies the integration type to be associated with the instance.\n\n*Allowed Values* : `LEX_BOT` | `LAMBDA_FUNCTION`"
|
|
10875
10916
|
}
|
|
10876
10917
|
},
|
|
10877
10918
|
"AWS::Connect::PhoneNumber": {
|
|
@@ -11017,13 +11058,13 @@
|
|
|
11017
11058
|
},
|
|
11018
11059
|
"AWS::Connect::SecurityKey": {
|
|
11019
11060
|
"attributes": {
|
|
11020
|
-
"AssociationId": "",
|
|
11061
|
+
"AssociationId": "An `AssociationId` is automatically generated when a storage config is associated with an instance.",
|
|
11021
11062
|
"Ref": ""
|
|
11022
11063
|
},
|
|
11023
|
-
"description": "
|
|
11064
|
+
"description": "The security key for the instance.\n\n> Only two security keys are allowed per Amazon Connect instance.",
|
|
11024
11065
|
"properties": {
|
|
11025
|
-
"InstanceId": "",
|
|
11026
|
-
"Key": "
|
|
11066
|
+
"InstanceId": "The Amazon Resource Name (ARN) of the instance.\n\n*Minimum* : `1`\n\n*Maximum* : `100`",
|
|
11067
|
+
"Key": "A valid security key in PEM format.\n\n*Minimum* : `1`\n\n*Maximum* : `1024`"
|
|
11027
11068
|
}
|
|
11028
11069
|
},
|
|
11029
11070
|
"AWS::Connect::TaskTemplate": {
|
|
@@ -13229,12 +13270,12 @@
|
|
|
13229
13270
|
"description": "Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.",
|
|
13230
13271
|
"properties": {
|
|
13231
13272
|
"CloudFormation": "Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the *AWS CloudFormation User Guide* .",
|
|
13232
|
-
"Tags": "The AWS tags used to filter the resources in the resource collection.\n\nTags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/https://
|
|
13273
|
+
"Tags": "The AWS tags used to filter the resources in the resource collection.\n\nTags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper.\n\nEach AWS tag has two parts.\n\n- A tag *key* (for example, `CostCenter` , `Environment` , `Project` , or `Secret` ). Tag *keys* are case-sensitive.\n- An optional field known as a tag *value* (for example, `111122223333` , `Production` , or a team name). Omitting the tag *value* is the same as using an empty string. Like tag *keys* , tag *values* are case-sensitive.\n\nTogether these are known as *key* - *value* pairs.\n\n> The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-` . The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers` ."
|
|
13233
13274
|
}
|
|
13234
13275
|
},
|
|
13235
13276
|
"AWS::DevOpsGuru::ResourceCollection.TagCollection": {
|
|
13236
13277
|
"attributes": {},
|
|
13237
|
-
"description": "A collection of AWS tags.\n\nTags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/https://
|
|
13278
|
+
"description": "A collection of AWS tags.\n\nTags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper.\n\nEach AWS tag has two parts.\n\n- A tag *key* (for example, `CostCenter` , `Environment` , `Project` , or `Secret` ). Tag *keys* are case-sensitive.\n- An optional field known as a tag *value* (for example, `111122223333` , `Production` , or a team name). Omitting the tag *value* is the same as using an empty string. Like tag *keys* , tag *values* are case-sensitive.\n\nTogether these are known as *key* - *value* pairs.\n\n> The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-` . The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers` .",
|
|
13238
13279
|
"properties": {
|
|
13239
13280
|
"AppBoundaryKey": "An AWS tag *key* that is used to identify the AWS resources that DevOps Guru analyzes. All AWS resources in your account and Region tagged with this *key* make up your DevOps Guru application and analysis boundary.\n\n> The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-` . The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers` .",
|
|
13240
13281
|
"TagValues": "The values in an AWS tag collection.\n\nThe tag's *value* is an optional field used to associate a string with the tag *key* (for example, `111122223333` , `Production` , or a team name). The *key* and *value* are the tag's *key* pair. Omitting the tag *value* is the same as using an empty string. Like tag *keys* , tag *values* are case-sensitive. You can specify a maximum of 256 characters for a tag value."
|
|
@@ -13890,7 +13931,7 @@
|
|
|
13890
13931
|
},
|
|
13891
13932
|
"AWS::EC2::CapacityReservationFleet.TagSpecification": {
|
|
13892
13933
|
"attributes": {},
|
|
13893
|
-
"description": "The tags to apply to a resource when the resource is being created.\n\n> The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.",
|
|
13934
|
+
"description": "The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.\n\n> The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.",
|
|
13894
13935
|
"properties": {
|
|
13895
13936
|
"ResourceType": "The type of resource to tag on creation. Specify `capacity-reservation-fleet` .\n\nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .",
|
|
13896
13937
|
"Tags": "The tags to apply to the resource."
|
|
@@ -14003,7 +14044,7 @@
|
|
|
14003
14044
|
},
|
|
14004
14045
|
"AWS::EC2::ClientVpnEndpoint.TagSpecification": {
|
|
14005
14046
|
"attributes": {},
|
|
14006
|
-
"description": "The tags to apply to a resource when the resource is being created.\n\n> The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.",
|
|
14047
|
+
"description": "The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.\n\n> The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.",
|
|
14007
14048
|
"properties": {
|
|
14008
14049
|
"ResourceType": "The type of resource to tag.",
|
|
14009
14050
|
"Tags": "The tags to apply to the resource."
|
|
@@ -14305,7 +14346,7 @@
|
|
|
14305
14346
|
"NetworkBorderGroup": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.\n\nUse [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.\n\nYou cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an `InvalidParameterCombination` error.",
|
|
14306
14347
|
"PublicIpv4Pool": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n\n> Updates to the `PublicIpv4Pool` property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.",
|
|
14307
14348
|
"Tags": "Any tags assigned to the Elastic IP address.\n\n> Updates to the `Tags` property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.",
|
|
14308
|
-
"TransferAddress": "The Elastic IP address you are accepting for transfer."
|
|
14349
|
+
"TransferAddress": "The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide* ."
|
|
14309
14350
|
}
|
|
14310
14351
|
},
|
|
14311
14352
|
"AWS::EC2::EIPAssociation": {
|
|
@@ -14460,6 +14501,7 @@
|
|
|
14460
14501
|
"IpamScopeId": "The ID of the scope in which you would like to create the IPAM pool.",
|
|
14461
14502
|
"Locale": "The locale of the IPAM pool. In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.",
|
|
14462
14503
|
"ProvisionedCidrs": "Information about the CIDRs provisioned to an IPAM pool.",
|
|
14504
|
+
"PublicIpSource": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `BYOIP` . For more information, see [Create IPv6 pools](https://docs.aws.amazon.com//vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide* . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see [Quotas for your IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
14463
14505
|
"PubliclyAdvertisable": "Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to `ipv4` .",
|
|
14464
14506
|
"SourceIpamPoolId": "The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.",
|
|
14465
14507
|
"Tags": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA` , specify `tag:Owner` for the filter name and `TeamA` for the filter value."
|
|
@@ -14467,11 +14509,65 @@
|
|
|
14467
14509
|
},
|
|
14468
14510
|
"AWS::EC2::IPAMPool.ProvisionedCidr": {
|
|
14469
14511
|
"attributes": {},
|
|
14470
|
-
"description": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .",
|
|
14512
|
+
"description": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .\n\n> This resource type does not allow you to provision a CIDR using the netmask length. To provision a CIDR using netmask length, use [AWS::EC2::IPAMPoolCidr](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html) .",
|
|
14471
14513
|
"properties": {
|
|
14472
14514
|
"Cidr": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` ."
|
|
14473
14515
|
}
|
|
14474
14516
|
},
|
|
14517
|
+
"AWS::EC2::IPAMPoolCidr": {
|
|
14518
|
+
"attributes": {
|
|
14519
|
+
"IpamPoolCidrId": "The IPAM pool CIDR ID.",
|
|
14520
|
+
"Ref": "`Ref` returns the IPAM pool ID and IPAM pool CIDR ID in the following format: `ipam-pool-01123456|ipam-pool-cidr-0123456` .",
|
|
14521
|
+
"State": "The state of the CIDR."
|
|
14522
|
+
},
|
|
14523
|
+
"description": "A CIDR provisioned to an IPAM pool.",
|
|
14524
|
+
"properties": {
|
|
14525
|
+
"Cidr": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .",
|
|
14526
|
+
"IpamPoolId": "The ID of the IPAM pool.",
|
|
14527
|
+
"NetmaskLength": "The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. \"NetmaskLength\" or \"Cidr\" is required."
|
|
14528
|
+
}
|
|
14529
|
+
},
|
|
14530
|
+
"AWS::EC2::IPAMResourceDiscovery": {
|
|
14531
|
+
"attributes": {
|
|
14532
|
+
"IpamResourceDiscoveryArn": "The resource discovery ARN.",
|
|
14533
|
+
"IpamResourceDiscoveryId": "The resource discovery ID.",
|
|
14534
|
+
"IpamResourceDiscoveryRegion": "The resource discovery Region.",
|
|
14535
|
+
"IsDefault": "Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.",
|
|
14536
|
+
"OwnerId": "The owner ID.",
|
|
14537
|
+
"Ref": "`Ref` returns the resource discovery ID. For example: `ipam-res-disco-111122223333` .",
|
|
14538
|
+
"State": "The resource discovery's state.\n\n- `create-in-progress` - Resource discovery is being created.\n- `create-complete` - Resource discovery creation is complete.\n- `create-failed` - Resource discovery creation has failed.\n- `modify-in-progress` - Resource discovery is being modified.\n- `modify-complete` - Resource discovery modification is complete.\n- `modify-failed` - Resource discovery modification has failed.\n- `delete-in-progress` - Resource discovery is being deleted.\n- `delete-complete` - Resource discovery deletion is complete.\n- `delete-failed` - Resource discovery deletion has failed.\n- `isolate-in-progress` - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.\n- `isolate-complete` - Resource discovery isolation is complete.\n- `restore-in-progress` - AWS account that created the resource discovery and was isolated has been restored."
|
|
14539
|
+
},
|
|
14540
|
+
"description": "A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.",
|
|
14541
|
+
"properties": {
|
|
14542
|
+
"Description": "The resource discovery description.",
|
|
14543
|
+
"OperatingRegions": "The operating Regions for the resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.",
|
|
14544
|
+
"Tags": "A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs."
|
|
14545
|
+
}
|
|
14546
|
+
},
|
|
14547
|
+
"AWS::EC2::IPAMResourceDiscovery.IpamOperatingRegion": {
|
|
14548
|
+
"attributes": {},
|
|
14549
|
+
"description": "The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.\n\nFor more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
14550
|
+
"properties": {
|
|
14551
|
+
"RegionName": "The name of the operating Region."
|
|
14552
|
+
}
|
|
14553
|
+
},
|
|
14554
|
+
"AWS::EC2::IPAMResourceDiscoveryAssociation": {
|
|
14555
|
+
"attributes": {
|
|
14556
|
+
"IpamResourceDiscoveryAssociationArn": "The resource discovery association ARN.",
|
|
14557
|
+
"IpamResourceDiscoveryAssociationId": "The resource discovery association ID.",
|
|
14558
|
+
"IsDefault": "Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.",
|
|
14559
|
+
"OwnerId": "The owner ID.",
|
|
14560
|
+
"Ref": "`Ref` returns the resource discovery ID. For example: `ipam-res-disco-111122223333` .",
|
|
14561
|
+
"State": "The lifecycle state of the association when you associate or disassociate a resource discovery.\n\n- `associate-in-progress` - Resource discovery is being associated.\n- `associate-complete` - Resource discovery association is complete.\n- `associate-failed` - Resource discovery association has failed.\n- `disassociate-in-progress` - Resource discovery is being disassociated.\n- `disassociate-complete` - Resource discovery disassociation is complete.\n- `disassociate-failed` - Resource discovery disassociation has failed.\n- `isolate-in-progress` - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.\n- `isolate-complete` - Resource discovery isolation is complete..\n- `restore-in-progress` - Resource discovery is being restored.",
|
|
14562
|
+
"Status": "The resource discovery status.\n\n- `active` : The connection or permissions required to read the results of the resource discovery are intact.\n- `not-found` : The connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still in tact."
|
|
14563
|
+
},
|
|
14564
|
+
"description": "An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.",
|
|
14565
|
+
"properties": {
|
|
14566
|
+
"IpamId": "The IPAM ID.",
|
|
14567
|
+
"IpamResourceDiscoveryId": "The resource discovery ID.",
|
|
14568
|
+
"Tags": "A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs."
|
|
14569
|
+
}
|
|
14570
|
+
},
|
|
14475
14571
|
"AWS::EC2::IPAMScope": {
|
|
14476
14572
|
"attributes": {
|
|
14477
14573
|
"Arn": "The ARN of the scope.",
|
|
@@ -14538,7 +14634,7 @@
|
|
|
14538
14634
|
"SubnetId": "[EC2-VPC] The ID of the subnet to launch the instance into.\n\nIf you specify a network interface, you must specify any subnets as part of the network interface.",
|
|
14539
14635
|
"Tags": "The tags to add to the instance. These tags are not applied to the EBS volumes, such as the root volume.",
|
|
14540
14636
|
"Tenancy": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of `dedicated` runs on single-tenant hardware.",
|
|
14541
|
-
"UserData": "The user data script to make available to the instance. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and [Run commands on your Windows instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html) .
|
|
14637
|
+
"UserData": "The user data script to make available to the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see [Fn::Base64](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html) .\n\nUser data runs only at instance launch. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and [Run commands on your Windows instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html) .",
|
|
14542
14638
|
"Volumes": "The volumes to attach to the instance."
|
|
14543
14639
|
}
|
|
14544
14640
|
},
|
|
@@ -15147,11 +15243,11 @@
|
|
|
15147
15243
|
"properties": {
|
|
15148
15244
|
"AllocationId": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.",
|
|
15149
15245
|
"ConnectivityType": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.",
|
|
15150
|
-
"MaxDrainDurationSeconds": "",
|
|
15246
|
+
"MaxDrainDurationSeconds": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.",
|
|
15151
15247
|
"PrivateIpAddress": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.",
|
|
15152
|
-
"SecondaryAllocationIds": "",
|
|
15153
|
-
"SecondaryPrivateIpAddressCount": "",
|
|
15154
|
-
"SecondaryPrivateIpAddresses": "",
|
|
15248
|
+
"SecondaryAllocationIds": "Secondary EIP allocation IDs. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .",
|
|
15249
|
+
"SecondaryPrivateIpAddressCount": "[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .\n\n> `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time.",
|
|
15250
|
+
"SecondaryPrivateIpAddresses": "Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .\n\n> `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time.",
|
|
15155
15251
|
"SubnetId": "The ID of the subnet in which the NAT gateway is located.",
|
|
15156
15252
|
"Tags": "The tags for the NAT gateway."
|
|
15157
15253
|
}
|
|
@@ -16649,7 +16745,7 @@
|
|
|
16649
16745
|
"SnapshotId": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.",
|
|
16650
16746
|
"Tags": "The tags to apply to the volume during creation.",
|
|
16651
16747
|
"Throughput": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.\n\nThis parameter is valid only for `gp3` volumes. The default value is 125.\n\nValid Range: Minimum value of 125. Maximum value of 1000.",
|
|
16652
|
-
"VolumeType": "The volume type. This parameter can be one of the following values:\n\n- General Purpose SSD: `gp2` | `gp3`\n- Provisioned IOPS SSD: `io1` | `io2`\n- Throughput Optimized HDD: `st1`\n- Cold HDD: `sc1`\n- Magnetic: `standard`\n\
|
|
16748
|
+
"VolumeType": "The volume type. This parameter can be one of the following values:\n\n- General Purpose SSD: `gp2` | `gp3`\n- Provisioned IOPS SSD: `io1` | `io2`\n- Throughput Optimized HDD: `st1`\n- Cold HDD: `sc1`\n- Magnetic: `standard`\n\nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide* .\n\nDefault: `gp2`"
|
|
16653
16749
|
}
|
|
16654
16750
|
},
|
|
16655
16751
|
"AWS::EC2::VolumeAttachment": {
|
|
@@ -19450,13 +19546,13 @@
|
|
|
19450
19546
|
},
|
|
19451
19547
|
"AWS::ElasticLoadBalancingV2::TargetGroup": {
|
|
19452
19548
|
"attributes": {
|
|
19453
|
-
"LoadBalancerArns": "The Amazon Resource
|
|
19549
|
+
"LoadBalancerArns": "The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.",
|
|
19454
19550
|
"Ref": "`Ref` returns the Amazon Resource Name (ARN) of the target group.",
|
|
19455
|
-
"TargetGroupArn": "",
|
|
19551
|
+
"TargetGroupArn": "The Amazon Resource Name (ARN) of the target group.",
|
|
19456
19552
|
"TargetGroupFullName": "The full name of the target group. For example, `targetgroup/my-target-group/cbf133c568e0d028` .",
|
|
19457
19553
|
"TargetGroupName": "The name of the target group. For example, `my-target-group` ."
|
|
19458
19554
|
},
|
|
19459
|
-
"description": "Specifies a target group for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.\n\
|
|
19555
|
+
"description": "Specifies a target group for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.\n\nBefore you register a Lambda function as a target, you must create a `AWS::Lambda::Permission` resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function.",
|
|
19460
19556
|
"properties": {
|
|
19461
19557
|
"HealthCheckEnabled": "Indicates whether health checks are enabled. If the target type is `lambda` , health checks are disabled by default but can be enabled. If the target type is `instance` , `ip` , or `alb` , health checks are always enabled and cannot be disabled.",
|
|
19462
19558
|
"HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is `lambda` , the default is 35 seconds.",
|
|
@@ -19464,7 +19560,7 @@
|
|
|
19464
19560
|
"HealthCheckPort": "The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is `traffic-port` , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.",
|
|
19465
19561
|
"HealthCheckProtocol": "The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.",
|
|
19466
19562
|
"HealthCheckTimeoutSeconds": "The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is `lambda` , the default is 30 seconds.",
|
|
19467
|
-
"HealthyThresholdCount": "The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is
|
|
19563
|
+
"HealthyThresholdCount": "The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is `lambda` , the default is 5.",
|
|
19468
19564
|
"IpAddressType": "The type of IP address used for this target group. The possible values are `ipv4` and `ipv6` . This is an optional parameter. If not specified, the IP address type defaults to `ipv4` .",
|
|
19469
19565
|
"Matcher": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.",
|
|
19470
19566
|
"Name": "The name of the target group.\n\nThis name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.",
|
|
@@ -19475,7 +19571,7 @@
|
|
|
19475
19571
|
"TargetGroupAttributes": "The attributes.",
|
|
19476
19572
|
"TargetType": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.\n\n- `instance` - Register targets by instance ID. This is the default value.\n- `ip` - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.\n- `lambda` - Register a single Lambda function as a target.\n- `alb` - Register a single Application Load Balancer as a target.",
|
|
19477
19573
|
"Targets": "The targets.",
|
|
19478
|
-
"UnhealthyThresholdCount": "The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is
|
|
19574
|
+
"UnhealthyThresholdCount": "The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is `lambda` , the default is 5.",
|
|
19479
19575
|
"VpcId": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required."
|
|
19480
19576
|
}
|
|
19481
19577
|
},
|
|
@@ -30352,7 +30448,7 @@
|
|
|
30352
30448
|
},
|
|
30353
30449
|
"AWS::LakeFormation::Resource": {
|
|
30354
30450
|
"attributes": {},
|
|
30355
|
-
"description": "The `AWS::LakeFormation::Resource` represents the data ( buckets and folders) that is being registered with AWS Lake Formation . During a stack operation, AWS CloudFormation calls the AWS Lake Formation [`RegisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-RegisterResource) API operation to register the resource. To remove a `Resource` type, AWS CloudFormation calls the AWS Lake Formation [`DeregisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-DeregisterResource) API operation.",
|
|
30451
|
+
"description": "The `AWS::LakeFormation::Resource` represents the data ( buckets and folders) that is being registered with AWS Lake Formation . During a stack operation, AWS CloudFormation calls the AWS Lake Formation [`RegisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-RegisterResource) API operation to register the resource. To remove a `Resource` type, AWS CloudFormation calls the AWS Lake Formation [`DeregisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-DeregisterResource) API operation.\n\n> `AWS::LakeFormation::Resource` is a legacy resource that doesn't support the `UPDATE` operation. Changes to the resource will require an explicit deletion and recreation to apply new properties.",
|
|
30356
30452
|
"properties": {
|
|
30357
30453
|
"ResourceArn": "The Amazon Resource Name (ARN) of the resource.",
|
|
30358
30454
|
"RoleArn": "The IAM role that registered a resource.",
|
|
@@ -30416,7 +30512,7 @@
|
|
|
30416
30512
|
"CatalogId": "The identifier for the Data Catalog . By default, it is the account ID of the caller.",
|
|
30417
30513
|
"DatabaseName": "The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.",
|
|
30418
30514
|
"Name": "The name of the table.",
|
|
30419
|
-
"TableWildcard": "A wildcard object representing every table under a database.\n\nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required."
|
|
30515
|
+
"TableWildcard": "A wildcard object representing every table under a database.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter. The valid inputs for a property with this type in either yaml or json is null or {}.\n\nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required."
|
|
30420
30516
|
}
|
|
30421
30517
|
},
|
|
30422
30518
|
"AWS::LakeFormation::TagAssociation.TableWithColumnsResource": {
|
|
@@ -30650,7 +30746,7 @@
|
|
|
30650
30746
|
"FunctionName": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.\n\nIf you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
|
|
30651
30747
|
"Handler": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html) .",
|
|
30652
30748
|
"ImageConfig": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .",
|
|
30653
|
-
"KmsKeyArn": "The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables.
|
|
30749
|
+
"KmsKeyArn": "The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) . When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key.",
|
|
30654
30750
|
"Layers": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.",
|
|
30655
30751
|
"MemorySize": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.",
|
|
30656
30752
|
"PackageType": "The type of deployment package. Set to `Image` for container image and set `Zip` for .zip file archive.",
|
|
@@ -30794,7 +30890,7 @@
|
|
|
30794
30890
|
"Action": "The action that the principal can use on the function. For example, `lambda:InvokeFunction` or `lambda:GetFunction` .",
|
|
30795
30891
|
"EventSourceToken": "For Alexa Smart Home functions, a token that the invoker must supply.",
|
|
30796
30892
|
"FunctionName": "The name of the Lambda function, version, or alias.\n\n**Name formats** - *Function name* – `my-function` (name-only), `my-function:v1` (with alias).\n- *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:my-function` .\n- *Partial ARN* – `123456789012:function:my-function` .\n\nYou can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
|
30797
|
-
"FunctionUrlAuthType": "The type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated
|
|
30893
|
+
"FunctionUrlAuthType": "The type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
|
30798
30894
|
"Principal": "The AWS service or AWS account that invokes the function. If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service.",
|
|
30799
30895
|
"PrincipalOrgID": "The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.",
|
|
30800
30896
|
"SourceAccount": "For AWS service , the ID of the AWS account that owns the resource. Use this together with `SourceArn` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.",
|
|
@@ -30809,7 +30905,7 @@
|
|
|
30809
30905
|
},
|
|
30810
30906
|
"description": "The `AWS::Lambda::Url` resource creates a function URL with the specified configuration parameters. A [function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) is a dedicated HTTP(S) endpoint that you can use to invoke your function.",
|
|
30811
30907
|
"properties": {
|
|
30812
|
-
"AuthType": "The type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated
|
|
30908
|
+
"AuthType": "The type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
|
30813
30909
|
"Cors": "The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.",
|
|
30814
30910
|
"InvokeMode": "",
|
|
30815
30911
|
"Qualifier": "The alias name.",
|
|
@@ -30853,16 +30949,16 @@
|
|
|
30853
30949
|
"Arn": "The Amazon Resource Name (ARN) of the bot.",
|
|
30854
30950
|
"Id": "The unique identifier of the bot."
|
|
30855
30951
|
},
|
|
30856
|
-
"description": "> Amazon Lex V2 is the only supported version in AWS CloudFormation . \n\nSpecifies an Amazon Lex conversational bot.\n\nYou must configure an intent based on the AMAZON.FallbackIntent built-in intent. If you don't add one, creating the bot will fail.",
|
|
30952
|
+
"description": "> Amazon Lex V2 is the only supported version in AWS CloudFormation . \n\nSpecifies an Amazon Lex conversational bot.\n\nYou must configure an intent based on the `AMAZON.FallbackIntent` built-in intent. If you don't add one, creating the bot will fail.",
|
|
30857
30953
|
"properties": {
|
|
30858
30954
|
"AutoBuildBotLocales": "Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.",
|
|
30859
30955
|
"BotFileS3Location": "The Amazon S3 location of files used to import a bot. The files must be in the import format specified in [JSON format for importing and exporting](https://docs.aws.amazon.com/lexv2/latest/dg/import-export-format.html) in the *Amazon Lex developer guide.*",
|
|
30860
30956
|
"BotLocales": "A list of locales for the bot.",
|
|
30861
30957
|
"BotTags": "A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the `UpdateBot` operation to update tags. To update tags, use the `TagResource` operation.",
|
|
30862
|
-
"DataPrivacy": "
|
|
30958
|
+
"DataPrivacy": "",
|
|
30863
30959
|
"Description": "The description of the version.",
|
|
30864
30960
|
"IdleSessionTTLInSeconds": "The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.\n\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.\n\nYou can specify between 60 (1 minute) and 86,400 (24 hours) seconds.",
|
|
30865
|
-
"Name": "The name of the
|
|
30961
|
+
"Name": "The name of the bot locale.",
|
|
30866
30962
|
"RoleArn": "The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.",
|
|
30867
30963
|
"TestBotAliasSettings": "Specifies configuration settings for the alias used to test the bot. If the `TestBotAliasSettings` property is not specified, the settings are configured with default values.",
|
|
30868
30964
|
"TestBotAliasTags": "A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the `UpdateAlias` operation to update tags. To update tags on the test alias, use the `TagResource` operation."
|
|
@@ -30870,57 +30966,57 @@
|
|
|
30870
30966
|
},
|
|
30871
30967
|
"AWS::Lex::Bot.AdvancedRecognitionSetting": {
|
|
30872
30968
|
"attributes": {},
|
|
30873
|
-
"description": "
|
|
30969
|
+
"description": "Provides settings that enable advanced recognition settings for slot values.",
|
|
30874
30970
|
"properties": {
|
|
30875
|
-
"AudioRecognitionStrategy": "
|
|
30971
|
+
"AudioRecognitionStrategy": "Enables using the slot values as a custom vocabulary for recognizing user utterances."
|
|
30876
30972
|
}
|
|
30877
30973
|
},
|
|
30878
30974
|
"AWS::Lex::Bot.AllowedInputTypes": {
|
|
30879
30975
|
"attributes": {},
|
|
30880
|
-
"description": "",
|
|
30976
|
+
"description": "Specifies the allowed input types.",
|
|
30881
30977
|
"properties": {
|
|
30882
|
-
"AllowAudioInput": "",
|
|
30883
|
-
"AllowDTMFInput": ""
|
|
30978
|
+
"AllowAudioInput": "Indicates whether audio input is allowed.",
|
|
30979
|
+
"AllowDTMFInput": "Indicates whether DTMF input is allowed."
|
|
30884
30980
|
}
|
|
30885
30981
|
},
|
|
30886
30982
|
"AWS::Lex::Bot.AudioAndDTMFInputSpecification": {
|
|
30887
30983
|
"attributes": {},
|
|
30888
|
-
"description": "",
|
|
30984
|
+
"description": "Specifies the audio and DTMF input specification.",
|
|
30889
30985
|
"properties": {
|
|
30890
|
-
"AudioSpecification": "",
|
|
30891
|
-
"DTMFSpecification": "",
|
|
30892
|
-
"StartTimeoutMs": ""
|
|
30986
|
+
"AudioSpecification": "Specifies the settings on audio input.",
|
|
30987
|
+
"DTMFSpecification": "Specifies the settings on DTMF input.",
|
|
30988
|
+
"StartTimeoutMs": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs."
|
|
30893
30989
|
}
|
|
30894
30990
|
},
|
|
30895
30991
|
"AWS::Lex::Bot.AudioLogDestination": {
|
|
30896
30992
|
"attributes": {},
|
|
30897
|
-
"description": "
|
|
30993
|
+
"description": "The location of audio log files collected when conversation logging is enabled for a bot.",
|
|
30898
30994
|
"properties": {
|
|
30899
30995
|
"S3Bucket": "Specifies the Amazon S3 bucket where the audio files are stored."
|
|
30900
30996
|
}
|
|
30901
30997
|
},
|
|
30902
30998
|
"AWS::Lex::Bot.AudioLogSetting": {
|
|
30903
30999
|
"attributes": {},
|
|
30904
|
-
"description": "
|
|
31000
|
+
"description": "Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.",
|
|
30905
31001
|
"properties": {
|
|
30906
31002
|
"Destination": "Specifies the location of the audio log files collected when conversation logging is enabled for a bot.",
|
|
30907
|
-
"Enabled": "
|
|
31003
|
+
"Enabled": "Determines whether audio logging in enabled for the bot."
|
|
30908
31004
|
}
|
|
30909
31005
|
},
|
|
30910
31006
|
"AWS::Lex::Bot.AudioSpecification": {
|
|
30911
31007
|
"attributes": {},
|
|
30912
|
-
"description": "",
|
|
31008
|
+
"description": "Specifies the audio input specifications.",
|
|
30913
31009
|
"properties": {
|
|
30914
|
-
"EndTimeoutMs": "",
|
|
30915
|
-
"MaxLengthMs": ""
|
|
31010
|
+
"EndTimeoutMs": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished.",
|
|
31011
|
+
"MaxLengthMs": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application."
|
|
30916
31012
|
}
|
|
30917
31013
|
},
|
|
30918
31014
|
"AWS::Lex::Bot.BotAliasLocaleSettings": {
|
|
30919
31015
|
"attributes": {},
|
|
30920
|
-
"description": "Specifies settings that are unique to a locale. For example, you can use
|
|
31016
|
+
"description": "Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.",
|
|
30921
31017
|
"properties": {
|
|
30922
|
-
"CodeHookSpecification": "Specifies the Lambda function
|
|
30923
|
-
"Enabled": "
|
|
31018
|
+
"CodeHookSpecification": "Specifies the Lambda function that should be used in the locale.",
|
|
31019
|
+
"Enabled": "Determines whether the locale is enabled for the bot. If the value is `false` , the locale isn't available for use."
|
|
30924
31020
|
}
|
|
30925
31021
|
},
|
|
30926
31022
|
"AWS::Lex::Bot.BotAliasLocaleSettingsItem": {
|
|
@@ -30939,71 +31035,71 @@
|
|
|
30939
31035
|
"Description": "A description of the bot locale. Use this to help identify the bot locale in lists.",
|
|
30940
31036
|
"Intents": "One or more intents defined for the locale.",
|
|
30941
31037
|
"LocaleId": "The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales.",
|
|
30942
|
-
"NluConfidenceThreshold": "Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. You must configure an AMAZON.FallbackIntent. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.",
|
|
31038
|
+
"NluConfidenceThreshold": "Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent` , `AMAZON.KendraSearchIntent` , or both when returning alternative intents. You must configure an `AMAZON.FallbackIntent` . `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot.",
|
|
30943
31039
|
"SlotTypes": "One or more slot types defined for the locale.",
|
|
30944
|
-
"VoiceSettings": "
|
|
31040
|
+
"VoiceSettings": "Defines settings for using an Amazon Polly voice to communicate with a user."
|
|
30945
31041
|
}
|
|
30946
31042
|
},
|
|
30947
31043
|
"AWS::Lex::Bot.Button": {
|
|
30948
31044
|
"attributes": {},
|
|
30949
31045
|
"description": "Describes a button to use on a response card used to gather slot values from a user.",
|
|
30950
31046
|
"properties": {
|
|
30951
|
-
"Text": "The text that appears on the button. Use this to tell the user
|
|
31047
|
+
"Text": "The text that appears on the button. Use this to tell the user what value is returned when they choose this button.",
|
|
30952
31048
|
"Value": "The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot."
|
|
30953
31049
|
}
|
|
30954
31050
|
},
|
|
30955
31051
|
"AWS::Lex::Bot.CloudWatchLogGroupLogDestination": {
|
|
30956
31052
|
"attributes": {},
|
|
30957
|
-
"description": "
|
|
31053
|
+
"description": "The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.",
|
|
30958
31054
|
"properties": {
|
|
30959
|
-
"CloudWatchLogGroupArn": "
|
|
30960
|
-
"LogPrefix": "
|
|
31055
|
+
"CloudWatchLogGroupArn": "The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.",
|
|
31056
|
+
"LogPrefix": "The prefix of the log stream name within the log group that you specified"
|
|
30961
31057
|
}
|
|
30962
31058
|
},
|
|
30963
31059
|
"AWS::Lex::Bot.CodeHookSpecification": {
|
|
30964
31060
|
"attributes": {},
|
|
30965
|
-
"description": "
|
|
31061
|
+
"description": "Contains information about code hooks that Amazon Lex calls during a conversation.",
|
|
30966
31062
|
"properties": {
|
|
30967
31063
|
"LambdaCodeHook": "Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot."
|
|
30968
31064
|
}
|
|
30969
31065
|
},
|
|
30970
31066
|
"AWS::Lex::Bot.Condition": {
|
|
30971
31067
|
"attributes": {},
|
|
30972
|
-
"description": "",
|
|
31068
|
+
"description": "Provides an expression that evaluates to true or false.",
|
|
30973
31069
|
"properties": {
|
|
30974
|
-
"ExpressionString": ""
|
|
31070
|
+
"ExpressionString": "The expression string that is evaluated."
|
|
30975
31071
|
}
|
|
30976
31072
|
},
|
|
30977
31073
|
"AWS::Lex::Bot.ConditionalBranch": {
|
|
30978
31074
|
"attributes": {},
|
|
30979
|
-
"description": "",
|
|
31075
|
+
"description": "A set of actions that Amazon Lex should run if the condition is matched.",
|
|
30980
31076
|
"properties": {
|
|
30981
|
-
"Condition": "",
|
|
30982
|
-
"Name": "",
|
|
30983
|
-
"NextStep": "",
|
|
30984
|
-
"Response": ""
|
|
31077
|
+
"Condition": "Contains the expression to evaluate. If the condition is true, the branch's actions are taken.",
|
|
31078
|
+
"Name": "The name of the branch.",
|
|
31079
|
+
"NextStep": "The next step in the conversation.",
|
|
31080
|
+
"Response": "Specifies a list of message groups that Amazon Lex uses to respond the user input."
|
|
30985
31081
|
}
|
|
30986
31082
|
},
|
|
30987
31083
|
"AWS::Lex::Bot.ConditionalSpecification": {
|
|
30988
31084
|
"attributes": {},
|
|
30989
|
-
"description": "",
|
|
31085
|
+
"description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.",
|
|
30990
31086
|
"properties": {
|
|
30991
|
-
"ConditionalBranches": "",
|
|
30992
|
-
"DefaultBranch": "",
|
|
30993
|
-
"IsActive": ""
|
|
31087
|
+
"ConditionalBranches": "A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.",
|
|
31088
|
+
"DefaultBranch": "The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.",
|
|
31089
|
+
"IsActive": "Determines whether a conditional branch is active. When `IsActive` is false, the conditions are not evaluated."
|
|
30994
31090
|
}
|
|
30995
31091
|
},
|
|
30996
31092
|
"AWS::Lex::Bot.ConversationLogSettings": {
|
|
30997
31093
|
"attributes": {},
|
|
30998
|
-
"description": "
|
|
31094
|
+
"description": "Configures conversation logging that saves audio, text, and metadata for the conversations with your users.",
|
|
30999
31095
|
"properties": {
|
|
31000
|
-
"AudioLogSettings": "
|
|
31001
|
-
"TextLogSettings": "
|
|
31096
|
+
"AudioLogSettings": "The Amazon S3 settings for logging audio to an S3 bucket.",
|
|
31097
|
+
"TextLogSettings": "The Amazon CloudWatch Logs settings for logging text and metadata."
|
|
31002
31098
|
}
|
|
31003
31099
|
},
|
|
31004
31100
|
"AWS::Lex::Bot.CustomPayload": {
|
|
31005
31101
|
"attributes": {},
|
|
31006
|
-
"description": "A custom response string that Amazon Lex sends to your application. You define the content and structure
|
|
31102
|
+
"description": "A custom response string that Amazon Lex sends to your application. You define the content and structure the string.",
|
|
31007
31103
|
"properties": {
|
|
31008
31104
|
"Value": "The string that is sent to your application."
|
|
31009
31105
|
}
|
|
@@ -31025,70 +31121,70 @@
|
|
|
31025
31121
|
},
|
|
31026
31122
|
"AWS::Lex::Bot.DTMFSpecification": {
|
|
31027
31123
|
"attributes": {},
|
|
31028
|
-
"description": "",
|
|
31124
|
+
"description": "Specifies the DTMF input specifications.",
|
|
31029
31125
|
"properties": {
|
|
31030
|
-
"DeletionCharacter": "",
|
|
31031
|
-
"EndCharacter": "",
|
|
31032
|
-
"EndTimeoutMs": "",
|
|
31033
|
-
"MaxLength": ""
|
|
31126
|
+
"DeletionCharacter": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input.",
|
|
31127
|
+
"EndCharacter": "The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.",
|
|
31128
|
+
"EndTimeoutMs": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded.",
|
|
31129
|
+
"MaxLength": "The maximum number of DTMF digits allowed in an utterance."
|
|
31034
31130
|
}
|
|
31035
31131
|
},
|
|
31036
31132
|
"AWS::Lex::Bot.DataPrivacy": {
|
|
31037
31133
|
"attributes": {},
|
|
31038
|
-
"description": "",
|
|
31134
|
+
"description": "Provides information on additional privacy protections Amazon Lex should use with the bot's data.",
|
|
31039
31135
|
"properties": {
|
|
31040
|
-
"ChildDirected": ""
|
|
31136
|
+
"ChildDirected": "For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex *is* related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex *is not* related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](https://docs.aws.amazon.com/lex/faqs#data-security) ."
|
|
31041
31137
|
}
|
|
31042
31138
|
},
|
|
31043
31139
|
"AWS::Lex::Bot.DefaultConditionalBranch": {
|
|
31044
31140
|
"attributes": {},
|
|
31045
|
-
"description": "",
|
|
31141
|
+
"description": "A set of actions that Amazon Lex should run if none of the other conditions are met.",
|
|
31046
31142
|
"properties": {
|
|
31047
|
-
"NextStep": "",
|
|
31048
|
-
"Response": ""
|
|
31143
|
+
"NextStep": "The next step in the conversation.",
|
|
31144
|
+
"Response": "Specifies a list of message groups that Amazon Lex uses to respond the user input."
|
|
31049
31145
|
}
|
|
31050
31146
|
},
|
|
31051
31147
|
"AWS::Lex::Bot.DialogAction": {
|
|
31052
31148
|
"attributes": {},
|
|
31053
|
-
"description": "",
|
|
31149
|
+
"description": "Defines the action that the bot executes at runtime when the conversation reaches this step.",
|
|
31054
31150
|
"properties": {
|
|
31055
|
-
"SlotToElicit": "",
|
|
31056
|
-
"SuppressNextMessage": "",
|
|
31057
|
-
"Type": ""
|
|
31151
|
+
"SlotToElicit": "If the dialog action is `ElicitSlot` , defines the slot to elicit from the user.",
|
|
31152
|
+
"SuppressNextMessage": "When true the next message for the intent is not used.",
|
|
31153
|
+
"Type": "The action that the bot should execute."
|
|
31058
31154
|
}
|
|
31059
31155
|
},
|
|
31060
31156
|
"AWS::Lex::Bot.DialogCodeHookInvocationSetting": {
|
|
31061
31157
|
"attributes": {},
|
|
31062
|
-
"description": "",
|
|
31158
|
+
"description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.",
|
|
31063
31159
|
"properties": {
|
|
31064
|
-
"EnableCodeHookInvocation": "",
|
|
31065
|
-
"InvocationLabel": "",
|
|
31066
|
-
"IsActive": "",
|
|
31067
|
-
"PostCodeHookSpecification": ""
|
|
31160
|
+
"EnableCodeHookInvocation": "Indicates whether a Lambda function should be invoked for the dialog.",
|
|
31161
|
+
"InvocationLabel": "A label that indicates the dialog step from which the dialog code hook is happening.",
|
|
31162
|
+
"IsActive": "Determines whether a dialog code hook is used when the intent is activated.",
|
|
31163
|
+
"PostCodeHookSpecification": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete."
|
|
31068
31164
|
}
|
|
31069
31165
|
},
|
|
31070
31166
|
"AWS::Lex::Bot.DialogCodeHookSetting": {
|
|
31071
31167
|
"attributes": {},
|
|
31072
|
-
"description": "
|
|
31168
|
+
"description": "Settings that determine the Lambda function that Amazon Lex uses for processing user responses.",
|
|
31073
31169
|
"properties": {
|
|
31074
|
-
"Enabled": "
|
|
31170
|
+
"Enabled": "Enables the dialog code hook so that it processes user requests."
|
|
31075
31171
|
}
|
|
31076
31172
|
},
|
|
31077
31173
|
"AWS::Lex::Bot.DialogState": {
|
|
31078
31174
|
"attributes": {},
|
|
31079
|
-
"description": "",
|
|
31175
|
+
"description": "The current state of the conversation with the user.",
|
|
31080
31176
|
"properties": {
|
|
31081
|
-
"DialogAction": "",
|
|
31082
|
-
"Intent": "",
|
|
31083
|
-
"SessionAttributes": ""
|
|
31177
|
+
"DialogAction": "Defines the action that the bot executes at runtime when the conversation reaches this step.",
|
|
31178
|
+
"Intent": "Override settings to configure the intent state.",
|
|
31179
|
+
"SessionAttributes": "Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application."
|
|
31084
31180
|
}
|
|
31085
31181
|
},
|
|
31086
31182
|
"AWS::Lex::Bot.ElicitationCodeHookInvocationSetting": {
|
|
31087
31183
|
"attributes": {},
|
|
31088
|
-
"description": "",
|
|
31184
|
+
"description": "Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.",
|
|
31089
31185
|
"properties": {
|
|
31090
|
-
"EnableCodeHookInvocation": "",
|
|
31091
|
-
"InvocationLabel": ""
|
|
31186
|
+
"EnableCodeHookInvocation": "Indicates whether a Lambda function should be invoked for the dialog.",
|
|
31187
|
+
"InvocationLabel": "A label that indicates the dialog step from which the dialog code hook is happening."
|
|
31092
31188
|
}
|
|
31093
31189
|
},
|
|
31094
31190
|
"AWS::Lex::Bot.ExternalSourceSetting": {
|
|
@@ -31102,9 +31198,9 @@
|
|
|
31102
31198
|
"attributes": {},
|
|
31103
31199
|
"description": "Determines if a Lambda function should be invoked for a specific intent.",
|
|
31104
31200
|
"properties": {
|
|
31105
|
-
"Enabled": "Indicates whether a Lambda function should be invoked
|
|
31201
|
+
"Enabled": "Indicates whether a Lambda function should be invoked to fulfill a specific intent.",
|
|
31106
31202
|
"FulfillmentUpdatesSpecification": "Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.",
|
|
31107
|
-
"IsActive": "",
|
|
31203
|
+
"IsActive": "Determines whether the fulfillment code hook is used. When `active` is false, the code hook doesn't run.",
|
|
31108
31204
|
"PostFulfillmentStatusSpecification": "Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations."
|
|
31109
31205
|
}
|
|
31110
31206
|
},
|
|
@@ -31114,23 +31210,23 @@
|
|
|
31114
31210
|
"properties": {
|
|
31115
31211
|
"AllowInterrupt": "Determines whether the user can interrupt the start message while it is playing.",
|
|
31116
31212
|
"DelayInSeconds": "The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.",
|
|
31117
|
-
"MessageGroups": "
|
|
31213
|
+
"MessageGroups": "1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user."
|
|
31118
31214
|
}
|
|
31119
31215
|
},
|
|
31120
31216
|
"AWS::Lex::Bot.FulfillmentUpdateResponseSpecification": {
|
|
31121
31217
|
"attributes": {},
|
|
31122
|
-
"description": "Provides
|
|
31218
|
+
"description": "Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.",
|
|
31123
31219
|
"properties": {
|
|
31124
31220
|
"AllowInterrupt": "Determines whether the user can interrupt an update message while it is playing.",
|
|
31125
|
-
"FrequencyInSeconds": "The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda
|
|
31126
|
-
"MessageGroups": "
|
|
31221
|
+
"FrequencyInSeconds": "The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.",
|
|
31222
|
+
"MessageGroups": "1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user."
|
|
31127
31223
|
}
|
|
31128
31224
|
},
|
|
31129
31225
|
"AWS::Lex::Bot.FulfillmentUpdatesSpecification": {
|
|
31130
31226
|
"attributes": {},
|
|
31131
31227
|
"description": "Provides information for updating the user on the progress of fulfilling an intent.",
|
|
31132
31228
|
"properties": {
|
|
31133
|
-
"Active": "Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.\n\nIf the active field is set to true, the `startResponse` , `updateResponse` , and `timeoutInSeconds` fields are required.",
|
|
31229
|
+
"Active": "Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.\n\nIf the `active` field is set to true, the `startResponse` , `updateResponse` , and `timeoutInSeconds` fields are required.",
|
|
31134
31230
|
"StartResponse": "Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.",
|
|
31135
31231
|
"TimeoutInSeconds": "The length of time that the fulfillment Lambda function should run before it times out.",
|
|
31136
31232
|
"UpdateResponse": "Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running."
|
|
@@ -31138,25 +31234,25 @@
|
|
|
31138
31234
|
},
|
|
31139
31235
|
"AWS::Lex::Bot.GrammarSlotTypeSetting": {
|
|
31140
31236
|
"attributes": {},
|
|
31141
|
-
"description": "Settings
|
|
31237
|
+
"description": "Settings requried for a slot type based on a grammar that you provide.",
|
|
31142
31238
|
"properties": {
|
|
31143
31239
|
"Source": "The source of the grammar used to create the slot type."
|
|
31144
31240
|
}
|
|
31145
31241
|
},
|
|
31146
31242
|
"AWS::Lex::Bot.GrammarSlotTypeSource": {
|
|
31147
31243
|
"attributes": {},
|
|
31148
|
-
"description": "Describes the Amazon S3 bucket name and location for the grammar that is the source
|
|
31244
|
+
"description": "Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.",
|
|
31149
31245
|
"properties": {
|
|
31150
|
-
"KmsKeyArn": "The AWS
|
|
31151
|
-
"S3BucketName": "The name of the S3 bucket that contains the grammar source.",
|
|
31152
|
-
"S3ObjectKey": "The path to the grammar in the S3 bucket."
|
|
31246
|
+
"KmsKeyArn": "The AWS KMS key required to decrypt the contents of the grammar, if any.",
|
|
31247
|
+
"S3BucketName": "The name of the Amazon S3 bucket that contains the grammar source.",
|
|
31248
|
+
"S3ObjectKey": "The path to the grammar in the Amazon S3 bucket."
|
|
31153
31249
|
}
|
|
31154
31250
|
},
|
|
31155
31251
|
"AWS::Lex::Bot.ImageResponseCard": {
|
|
31156
31252
|
"attributes": {},
|
|
31157
31253
|
"description": "A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.\n\nWhen you use a response card, the response from the user is constrained to the text associated with a button on the card.",
|
|
31158
31254
|
"properties": {
|
|
31159
|
-
"Buttons": "A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the
|
|
31255
|
+
"Buttons": "A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.",
|
|
31160
31256
|
"ImageUrl": "The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.",
|
|
31161
31257
|
"Subtitle": "The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.",
|
|
31162
31258
|
"Title": "The title to display on the response card. The format of the title is determined by the platform displaying the response card."
|
|
@@ -31164,17 +31260,17 @@
|
|
|
31164
31260
|
},
|
|
31165
31261
|
"AWS::Lex::Bot.InitialResponseSetting": {
|
|
31166
31262
|
"attributes": {},
|
|
31167
|
-
"description": "",
|
|
31263
|
+
"description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.",
|
|
31168
31264
|
"properties": {
|
|
31169
|
-
"CodeHook": "",
|
|
31170
|
-
"Conditional": "",
|
|
31171
|
-
"InitialResponse": "",
|
|
31172
|
-
"NextStep": ""
|
|
31265
|
+
"CodeHook": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.",
|
|
31266
|
+
"Conditional": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.",
|
|
31267
|
+
"InitialResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input.",
|
|
31268
|
+
"NextStep": "The next step in the conversation."
|
|
31173
31269
|
}
|
|
31174
31270
|
},
|
|
31175
31271
|
"AWS::Lex::Bot.InputContext": {
|
|
31176
31272
|
"attributes": {},
|
|
31177
|
-
"description": "The name of a context that must be active for an intent to be selected by Amazon Lex
|
|
31273
|
+
"description": "The name of a context that must be active for an intent to be selected by Amazon Lex.",
|
|
31178
31274
|
"properties": {
|
|
31179
31275
|
"Name": "The name of the context."
|
|
31180
31276
|
}
|
|
@@ -31186,11 +31282,11 @@
|
|
|
31186
31282
|
"Description": "A description of the intent. Use the description to help identify the intent in lists.",
|
|
31187
31283
|
"DialogCodeHook": "Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.",
|
|
31188
31284
|
"FulfillmentCodeHook": "Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.",
|
|
31189
|
-
"InitialResponseSetting": "",
|
|
31285
|
+
"InitialResponseSetting": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.",
|
|
31190
31286
|
"InputContexts": "A list of contexts that must be active for this intent to be considered by Amazon Lex .",
|
|
31191
31287
|
"IntentClosingSetting": "Sets the response that Amazon Lex sends to the user when the intent is closed.",
|
|
31192
31288
|
"IntentConfirmationSetting": "Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers \"no,\" the settings contain a statement that is sent to the user to end the intent.",
|
|
31193
|
-
"KendraConfiguration": "
|
|
31289
|
+
"KendraConfiguration": "Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.",
|
|
31194
31290
|
"Name": "The name of the intent. Intent names must be unique within the locale that contains the intent and can't match the name of any built-in intent.",
|
|
31195
31291
|
"OutputContexts": "A list of contexts that the intent activates when it is fulfilled.",
|
|
31196
31292
|
"ParentIntentSignature": "A unique identifier for the built-in intent to base this intent on.",
|
|
@@ -31204,36 +31300,36 @@
|
|
|
31204
31300
|
"description": "Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.",
|
|
31205
31301
|
"properties": {
|
|
31206
31302
|
"ClosingResponse": "The response that Amazon Lex sends to the user when the intent is complete.",
|
|
31207
|
-
"Conditional": "",
|
|
31208
|
-
"IsActive": "Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user
|
|
31209
|
-
"NextStep": ""
|
|
31303
|
+
"Conditional": "A list of conditional branches associated with the intent's closing response. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional` .",
|
|
31304
|
+
"IsActive": "Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the `IsActive` field isn't specified, the default is true.",
|
|
31305
|
+
"NextStep": "Specifies the next step that the bot executes after playing the intent's closing response."
|
|
31210
31306
|
}
|
|
31211
31307
|
},
|
|
31212
31308
|
"AWS::Lex::Bot.IntentConfirmationSetting": {
|
|
31213
31309
|
"attributes": {},
|
|
31214
31310
|
"description": "Provides a prompt for making sure that the user is ready for the intent to be fulfilled.",
|
|
31215
31311
|
"properties": {
|
|
31216
|
-
"CodeHook": "",
|
|
31217
|
-
"ConfirmationConditional": "",
|
|
31218
|
-
"ConfirmationNextStep": "",
|
|
31219
|
-
"ConfirmationResponse": "",
|
|
31220
|
-
"DeclinationConditional": "",
|
|
31221
|
-
"DeclinationNextStep": "",
|
|
31222
|
-
"DeclinationResponse": "When the user answers \"no\" to the question defined in
|
|
31223
|
-
"ElicitationCodeHook": "",
|
|
31224
|
-
"FailureConditional": "",
|
|
31225
|
-
"FailureNextStep": "",
|
|
31226
|
-
"FailureResponse": "",
|
|
31227
|
-
"IsActive": "Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent
|
|
31228
|
-
"PromptSpecification": "Prompts the user to confirm the intent. This question should have a yes or no answer."
|
|
31312
|
+
"CodeHook": "The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook` .",
|
|
31313
|
+
"ConfirmationConditional": "A list of conditional branches to evaluate after the intent is closed.",
|
|
31314
|
+
"ConfirmationNextStep": "Specifies the next step that the bot executes when the customer confirms the intent.",
|
|
31315
|
+
"ConfirmationResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input.",
|
|
31316
|
+
"DeclinationConditional": "A list of conditional branches to evaluate after the intent is declined.",
|
|
31317
|
+
"DeclinationNextStep": "Specifies the next step that the bot executes when the customer declines the intent.",
|
|
31318
|
+
"DeclinationResponse": "When the user answers \"no\" to the question defined in `promptSpecification` , Amazon Lex responds with this response to acknowledge that the intent was canceled.",
|
|
31319
|
+
"ElicitationCodeHook": "The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries.",
|
|
31320
|
+
"FailureConditional": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.",
|
|
31321
|
+
"FailureNextStep": "The next step to take in the conversation if the confirmation step fails.",
|
|
31322
|
+
"FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.",
|
|
31323
|
+
"IsActive": "Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the `IsActive` field isn't specified, the default is true.",
|
|
31324
|
+
"PromptSpecification": "Prompts the user to confirm the intent. This question should have a yes or no answer.\n\nAmazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information."
|
|
31229
31325
|
}
|
|
31230
31326
|
},
|
|
31231
31327
|
"AWS::Lex::Bot.IntentOverride": {
|
|
31232
31328
|
"attributes": {},
|
|
31233
|
-
"description": "",
|
|
31329
|
+
"description": "Override settings to configure the intent state.",
|
|
31234
31330
|
"properties": {
|
|
31235
|
-
"Name": "",
|
|
31236
|
-
"Slots": ""
|
|
31331
|
+
"Name": "The name of the intent. Only required when you're switching intents.",
|
|
31332
|
+
"Slots": "A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden."
|
|
31237
31333
|
}
|
|
31238
31334
|
},
|
|
31239
31335
|
"AWS::Lex::Bot.KendraConfiguration": {
|
|
@@ -31241,7 +31337,7 @@
|
|
|
31241
31337
|
"description": "Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.",
|
|
31242
31338
|
"properties": {
|
|
31243
31339
|
"KendraIndex": "The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.",
|
|
31244
|
-
"QueryFilterString": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra.",
|
|
31340
|
+
"QueryFilterString": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html) .",
|
|
31245
31341
|
"QueryFilterStringEnabled": "Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index."
|
|
31246
31342
|
}
|
|
31247
31343
|
},
|
|
@@ -31249,8 +31345,8 @@
|
|
|
31249
31345
|
"attributes": {},
|
|
31250
31346
|
"description": "Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.",
|
|
31251
31347
|
"properties": {
|
|
31252
|
-
"CodeHookInterfaceVersion": "
|
|
31253
|
-
"LambdaArn": "
|
|
31348
|
+
"CodeHookInterfaceVersion": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.",
|
|
31349
|
+
"LambdaArn": "The Amazon Resource Name (ARN) of the Lambda function."
|
|
31254
31350
|
}
|
|
31255
31351
|
},
|
|
31256
31352
|
"AWS::Lex::Bot.Message": {
|
|
@@ -31260,7 +31356,7 @@
|
|
|
31260
31356
|
"CustomPayload": "A message in a custom format defined by the client application.",
|
|
31261
31357
|
"ImageResponseCard": "A message that defines a response card that the client application can show to the user.",
|
|
31262
31358
|
"PlainTextMessage": "A message in plain text format.",
|
|
31263
|
-
"SSMLMessage": "A message in Speech Synthesis Markup Language (SSML)
|
|
31359
|
+
"SSMLMessage": "A message in Speech Synthesis Markup Language (SSML)."
|
|
31264
31360
|
}
|
|
31265
31361
|
},
|
|
31266
31362
|
"AWS::Lex::Bot.MessageGroup": {
|
|
@@ -31275,14 +31371,14 @@
|
|
|
31275
31371
|
"attributes": {},
|
|
31276
31372
|
"description": "Indicates whether a slot can return multiple values.",
|
|
31277
31373
|
"properties": {
|
|
31278
|
-
"AllowMultipleValues": "Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value. If
|
|
31374
|
+
"AllowMultipleValues": "Indicates whether a slot can return multiple values. When `true` , the slot may return more than one value in a response. When `false` , the slot returns only a single value.\n\nMulti-value slots are only available in the en-US locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException` .\n\nIf the `allowMutlipleValues` is not set, the default value is `false` ."
|
|
31279
31375
|
}
|
|
31280
31376
|
},
|
|
31281
31377
|
"AWS::Lex::Bot.ObfuscationSetting": {
|
|
31282
31378
|
"attributes": {},
|
|
31283
31379
|
"description": "Determines whether Amazon Lex obscures slot values in conversation logs.",
|
|
31284
31380
|
"properties": {
|
|
31285
|
-
"ObfuscationSettingType": "Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values."
|
|
31381
|
+
"ObfuscationSettingType": "Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values. The valid values are `None` and `DefaultObfuscation.`"
|
|
31286
31382
|
}
|
|
31287
31383
|
},
|
|
31288
31384
|
"AWS::Lex::Bot.OutputContext": {
|
|
@@ -31303,42 +31399,42 @@
|
|
|
31303
31399
|
},
|
|
31304
31400
|
"AWS::Lex::Bot.PostDialogCodeHookInvocationSpecification": {
|
|
31305
31401
|
"attributes": {},
|
|
31306
|
-
"description": "",
|
|
31402
|
+
"description": "Specifies next steps to run after the dialog code hook finishes.",
|
|
31307
31403
|
"properties": {
|
|
31308
|
-
"FailureConditional": "",
|
|
31309
|
-
"FailureNextStep": "",
|
|
31310
|
-
"FailureResponse": "",
|
|
31311
|
-
"SuccessConditional": "",
|
|
31312
|
-
"SuccessNextStep": "",
|
|
31313
|
-
"SuccessResponse": "",
|
|
31314
|
-
"TimeoutConditional": "",
|
|
31315
|
-
"TimeoutNextStep": "",
|
|
31316
|
-
"TimeoutResponse": ""
|
|
31404
|
+
"FailureConditional": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` .",
|
|
31405
|
+
"FailureNextStep": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` .",
|
|
31406
|
+
"FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails.",
|
|
31407
|
+
"SuccessConditional": "A list of conditional branches to evaluate after the dialog code hook finishes successfully.",
|
|
31408
|
+
"SuccessNextStep": "Specifics the next step the bot runs after the dialog code hook finishes successfully.",
|
|
31409
|
+
"SuccessResponse": "Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds.",
|
|
31410
|
+
"TimeoutConditional": "A list of conditional branches to evaluate if the code hook times out.",
|
|
31411
|
+
"TimeoutNextStep": "Specifies the next step that the bot runs when the code hook times out.",
|
|
31412
|
+
"TimeoutResponse": "Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out."
|
|
31317
31413
|
}
|
|
31318
31414
|
},
|
|
31319
31415
|
"AWS::Lex::Bot.PostFulfillmentStatusSpecification": {
|
|
31320
31416
|
"attributes": {},
|
|
31321
|
-
"description": "Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see [
|
|
31417
|
+
"description": "Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see [](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete)",
|
|
31322
31418
|
"properties": {
|
|
31323
|
-
"FailureConditional": "",
|
|
31324
|
-
"FailureNextStep": "",
|
|
31419
|
+
"FailureConditional": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` .",
|
|
31420
|
+
"FailureNextStep": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` .",
|
|
31325
31421
|
"FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful.",
|
|
31326
|
-
"SuccessConditional": "",
|
|
31327
|
-
"SuccessNextStep": "",
|
|
31422
|
+
"SuccessConditional": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.",
|
|
31423
|
+
"SuccessNextStep": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.",
|
|
31328
31424
|
"SuccessResponse": "Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful.",
|
|
31329
|
-
"TimeoutConditional": "",
|
|
31330
|
-
"TimeoutNextStep": "",
|
|
31425
|
+
"TimeoutConditional": "A list of conditional branches to evaluate if the fulfillment code hook times out.",
|
|
31426
|
+
"TimeoutNextStep": "Specifies the next step that the bot runs when the fulfillment code hook times out.",
|
|
31331
31427
|
"TimeoutResponse": "Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period."
|
|
31332
31428
|
}
|
|
31333
31429
|
},
|
|
31334
31430
|
"AWS::Lex::Bot.PromptAttemptSpecification": {
|
|
31335
31431
|
"attributes": {},
|
|
31336
|
-
"description": "",
|
|
31432
|
+
"description": "Specifies the settings on a prompt attempt.",
|
|
31337
31433
|
"properties": {
|
|
31338
|
-
"AllowInterrupt": "",
|
|
31339
|
-
"AllowedInputTypes": "",
|
|
31340
|
-
"AudioAndDTMFInputSpecification": "",
|
|
31341
|
-
"TextInputSpecification": ""
|
|
31434
|
+
"AllowInterrupt": "Indicates whether the user can interrupt a speech prompt attempt from the bot.",
|
|
31435
|
+
"AllowedInputTypes": "Indicates the allowed input types of the prompt attempt.",
|
|
31436
|
+
"AudioAndDTMFInputSpecification": "Specifies the settings on audio and DTMF input.",
|
|
31437
|
+
"TextInputSpecification": "Specifies the settings on text input."
|
|
31342
31438
|
}
|
|
31343
31439
|
},
|
|
31344
31440
|
"AWS::Lex::Bot.PromptSpecification": {
|
|
@@ -31346,27 +31442,27 @@
|
|
|
31346
31442
|
"description": "Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.",
|
|
31347
31443
|
"properties": {
|
|
31348
31444
|
"AllowInterrupt": "Indicates whether the user can interrupt a speech prompt from the bot.",
|
|
31349
|
-
"MaxRetries": "The maximum number of times the bot tries to elicit a response from the user using this prompt",
|
|
31350
|
-
"MessageGroupsList": "A collection of
|
|
31351
|
-
"MessageSelectionStrategy": "",
|
|
31352
|
-
"PromptAttemptsSpecification": ""
|
|
31445
|
+
"MaxRetries": "The maximum number of times the bot tries to elicit a response from the user using this prompt.",
|
|
31446
|
+
"MessageGroupsList": "A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.",
|
|
31447
|
+
"MessageSelectionStrategy": "Indicates how a message is selected from a message group among retries.",
|
|
31448
|
+
"PromptAttemptsSpecification": "Specifies the advanced settings on each attempt of the prompt."
|
|
31353
31449
|
}
|
|
31354
31450
|
},
|
|
31355
31451
|
"AWS::Lex::Bot.ResponseSpecification": {
|
|
31356
31452
|
"attributes": {},
|
|
31357
|
-
"description": "Specifies a list of message groups that Amazon Lex uses to respond
|
|
31453
|
+
"description": "Specifies a list of message groups that Amazon Lex uses to respond the user input.",
|
|
31358
31454
|
"properties": {
|
|
31359
|
-
"AllowInterrupt": "Indicates whether the user can interrupt a speech response from Amazon Lex
|
|
31455
|
+
"AllowInterrupt": "Indicates whether the user can interrupt a speech response from Amazon Lex.",
|
|
31360
31456
|
"MessageGroupsList": "A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime."
|
|
31361
31457
|
}
|
|
31362
31458
|
},
|
|
31363
31459
|
"AWS::Lex::Bot.S3BucketLogDestination": {
|
|
31364
31460
|
"attributes": {},
|
|
31365
|
-
"description": "Specifies an Amazon S3 bucket for logging audio conversations
|
|
31461
|
+
"description": "Specifies an Amazon S3 bucket for logging audio conversations",
|
|
31366
31462
|
"properties": {
|
|
31367
|
-
"KmsKeyArn": "
|
|
31368
|
-
"LogPrefix": "
|
|
31369
|
-
"S3BucketArn": "
|
|
31463
|
+
"KmsKeyArn": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.",
|
|
31464
|
+
"LogPrefix": "The S3 prefix to assign to audio log files.",
|
|
31465
|
+
"S3BucketArn": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored."
|
|
31370
31466
|
}
|
|
31371
31467
|
},
|
|
31372
31468
|
"AWS::Lex::Bot.S3Location": {
|
|
@@ -31387,9 +31483,9 @@
|
|
|
31387
31483
|
},
|
|
31388
31484
|
"AWS::Lex::Bot.SampleUtterance": {
|
|
31389
31485
|
"attributes": {},
|
|
31390
|
-
"description": "A sample utterance that invokes
|
|
31486
|
+
"description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt.",
|
|
31391
31487
|
"properties": {
|
|
31392
|
-
"Utterance": "
|
|
31488
|
+
"Utterance": "A sample utterance that invokes an intent or respond to a slot elicitation prompt."
|
|
31393
31489
|
}
|
|
31394
31490
|
},
|
|
31395
31491
|
"AWS::Lex::Bot.SampleValue": {
|
|
@@ -31401,43 +31497,43 @@
|
|
|
31401
31497
|
},
|
|
31402
31498
|
"AWS::Lex::Bot.SentimentAnalysisSettings": {
|
|
31403
31499
|
"attributes": {},
|
|
31404
|
-
"description": "",
|
|
31500
|
+
"description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.",
|
|
31405
31501
|
"properties": {
|
|
31406
|
-
"DetectSentiment": ""
|
|
31502
|
+
"DetectSentiment": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances."
|
|
31407
31503
|
}
|
|
31408
31504
|
},
|
|
31409
31505
|
"AWS::Lex::Bot.SessionAttribute": {
|
|
31410
31506
|
"attributes": {},
|
|
31411
|
-
"description": "",
|
|
31507
|
+
"description": "A key/value pair representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.",
|
|
31412
31508
|
"properties": {
|
|
31413
|
-
"Key": "",
|
|
31414
|
-
"Value": ""
|
|
31509
|
+
"Key": "The name of the session attribute.",
|
|
31510
|
+
"Value": "The session-specific context information for the session attribute."
|
|
31415
31511
|
}
|
|
31416
31512
|
},
|
|
31417
31513
|
"AWS::Lex::Bot.Slot": {
|
|
31418
31514
|
"attributes": {},
|
|
31419
31515
|
"description": "Specifies the definition of a slot. Amazon Lex elicits slot values from uses to fulfill the user's intent.",
|
|
31420
31516
|
"properties": {
|
|
31421
|
-
"Description": "
|
|
31422
|
-
"MultipleValuesSetting": "
|
|
31423
|
-
"Name": "The name
|
|
31517
|
+
"Description": "The description of the slot.",
|
|
31518
|
+
"MultipleValuesSetting": "Indicates whether a slot can return multiple values.",
|
|
31519
|
+
"Name": "The name given to the slot.",
|
|
31424
31520
|
"ObfuscationSetting": "Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs. Use obfuscated slots to protect information such as personally identifiable information (PII) in logs.",
|
|
31425
31521
|
"SlotTypeName": "The name of the slot type that this slot is based on. The slot type defines the acceptable values for the slot.",
|
|
31426
|
-
"ValueElicitationSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n-
|
|
31522
|
+
"ValueElicitationSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to a slot value.\n- TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."
|
|
31427
31523
|
}
|
|
31428
31524
|
},
|
|
31429
31525
|
"AWS::Lex::Bot.SlotCaptureSetting": {
|
|
31430
31526
|
"attributes": {},
|
|
31431
|
-
"description": "",
|
|
31527
|
+
"description": "Settings used when Amazon Lex successfully captures a slot value from a user.",
|
|
31432
31528
|
"properties": {
|
|
31433
|
-
"CaptureConditional": "",
|
|
31434
|
-
"CaptureNextStep": "",
|
|
31435
|
-
"CaptureResponse": "",
|
|
31436
|
-
"CodeHook": "",
|
|
31437
|
-
"ElicitationCodeHook": "",
|
|
31438
|
-
"FailureConditional": "",
|
|
31439
|
-
"FailureNextStep": "",
|
|
31440
|
-
"FailureResponse": ""
|
|
31529
|
+
"CaptureConditional": "A list of conditional branches to evaluate after the slot value is captured.",
|
|
31530
|
+
"CaptureNextStep": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out.",
|
|
31531
|
+
"CaptureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input.",
|
|
31532
|
+
"CodeHook": "Code hook called after Amazon Lex successfully captures a slot value.",
|
|
31533
|
+
"ElicitationCodeHook": "Code hook called when Amazon Lex doesn't capture a slot value.",
|
|
31534
|
+
"FailureConditional": "A list of conditional branches to evaluate when the slot value isn't captured.",
|
|
31535
|
+
"FailureNextStep": "Specifies the next step that the bot runs when the slot value code is not recognized.",
|
|
31536
|
+
"FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured."
|
|
31441
31537
|
}
|
|
31442
31538
|
},
|
|
31443
31539
|
"AWS::Lex::Bot.SlotDefaultValue": {
|
|
@@ -31449,16 +31545,16 @@
|
|
|
31449
31545
|
},
|
|
31450
31546
|
"AWS::Lex::Bot.SlotDefaultValueSpecification": {
|
|
31451
31547
|
"attributes": {},
|
|
31452
|
-
"description": "
|
|
31548
|
+
"description": "The default value to use when a user doesn't provide a value for a slot.",
|
|
31453
31549
|
"properties": {
|
|
31454
31550
|
"DefaultValueList": "A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list."
|
|
31455
31551
|
}
|
|
31456
31552
|
},
|
|
31457
31553
|
"AWS::Lex::Bot.SlotPriority": {
|
|
31458
31554
|
"attributes": {},
|
|
31459
|
-
"description": "Sets the priority that Amazon Lex should use when eliciting
|
|
31555
|
+
"description": "Sets the priority that Amazon Lex should use when eliciting slot values from a user.",
|
|
31460
31556
|
"properties": {
|
|
31461
|
-
"Priority": "The priority that
|
|
31557
|
+
"Priority": "The priority that a slot should be elicited.",
|
|
31462
31558
|
"SlotName": "The name of the slot."
|
|
31463
31559
|
}
|
|
31464
31560
|
},
|
|
@@ -31469,14 +31565,14 @@
|
|
|
31469
31565
|
"Description": "A description of the slot type. Use the description to help identify the slot type in lists.",
|
|
31470
31566
|
"ExternalSourceSetting": "Sets the type of external information used to create the slot type.",
|
|
31471
31567
|
"Name": "The name of the slot type. A slot type name must be unique withing the account.",
|
|
31472
|
-
"ParentSlotTypeSignature": "The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent lot type.\n\nOnly AMAZON.AlphaNumeric is supported.",
|
|
31568
|
+
"ParentSlotTypeSignature": "The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent lot type.\n\nOnly `AMAZON.AlphaNumeric` is supported.",
|
|
31473
31569
|
"SlotTypeValues": "A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot.",
|
|
31474
|
-
"ValueSelectionSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n-
|
|
31570
|
+
"ValueSelectionSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.\n- `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."
|
|
31475
31571
|
}
|
|
31476
31572
|
},
|
|
31477
31573
|
"AWS::Lex::Bot.SlotTypeValue": {
|
|
31478
31574
|
"attributes": {},
|
|
31479
|
-
"description": "Each slot type can have a set of values.
|
|
31575
|
+
"description": "Each slot type can have a set of values. Each `SlotTypeValue` represents a value that the slot type can take.",
|
|
31480
31576
|
"properties": {
|
|
31481
31577
|
"SampleValue": "The value of the slot type entry.",
|
|
31482
31578
|
"Synonyms": "Additional values related to the slot type entry."
|
|
@@ -31484,54 +31580,54 @@
|
|
|
31484
31580
|
},
|
|
31485
31581
|
"AWS::Lex::Bot.SlotValue": {
|
|
31486
31582
|
"attributes": {},
|
|
31487
|
-
"description": "",
|
|
31583
|
+
"description": "The value to set in a slot.",
|
|
31488
31584
|
"properties": {
|
|
31489
|
-
"InterpretedValue": ""
|
|
31585
|
+
"InterpretedValue": "The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list."
|
|
31490
31586
|
}
|
|
31491
31587
|
},
|
|
31492
31588
|
"AWS::Lex::Bot.SlotValueElicitationSetting": {
|
|
31493
31589
|
"attributes": {},
|
|
31494
|
-
"description": "
|
|
31590
|
+
"description": "Specifies the elicitation setting details for constituent sub slots of a composite slot.",
|
|
31495
31591
|
"properties": {
|
|
31496
31592
|
"DefaultValueSpecification": "A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.",
|
|
31497
31593
|
"PromptSpecification": "The prompt that Amazon Lex uses to elicit the slot value from the user.",
|
|
31498
|
-
"SampleUtterances": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances.",
|
|
31499
|
-
"SlotCaptureSetting": "",
|
|
31594
|
+
"SampleUtterances": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.",
|
|
31595
|
+
"SlotCaptureSetting": "Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.",
|
|
31500
31596
|
"SlotConstraint": "Specifies whether the slot is required or optional.",
|
|
31501
31597
|
"WaitAndContinueSpecification": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input."
|
|
31502
31598
|
}
|
|
31503
31599
|
},
|
|
31504
31600
|
"AWS::Lex::Bot.SlotValueOverride": {
|
|
31505
31601
|
"attributes": {},
|
|
31506
|
-
"description": "",
|
|
31602
|
+
"description": "The slot values that Amazon Lex uses when it sets slot values in a dialog step.",
|
|
31507
31603
|
"properties": {
|
|
31508
|
-
"Shape": "",
|
|
31509
|
-
"Value": "",
|
|
31510
|
-
"Values": ""
|
|
31604
|
+
"Shape": "When the shape value is `List` , it indicates that the `values` field contains a list of slot values. When the value is `Scalar` , it indicates that the `value` field contains a single value.",
|
|
31605
|
+
"Value": "The current value of the slot.",
|
|
31606
|
+
"Values": "A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\""
|
|
31511
31607
|
}
|
|
31512
31608
|
},
|
|
31513
31609
|
"AWS::Lex::Bot.SlotValueOverrideMap": {
|
|
31514
31610
|
"attributes": {},
|
|
31515
|
-
"description": "",
|
|
31611
|
+
"description": "Maps a slot name to the [SlotValueOverride](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SlotValueOverride.html) object.",
|
|
31516
31612
|
"properties": {
|
|
31517
|
-
"SlotName": "",
|
|
31518
|
-
"SlotValueOverride": ""
|
|
31613
|
+
"SlotName": "The name of the slot.",
|
|
31614
|
+
"SlotValueOverride": "The SlotValueOverride object to which the slot name will be mapped."
|
|
31519
31615
|
}
|
|
31520
31616
|
},
|
|
31521
31617
|
"AWS::Lex::Bot.SlotValueRegexFilter": {
|
|
31522
31618
|
"attributes": {},
|
|
31523
31619
|
"description": "Provides a regular expression used to validate the value of a slot.",
|
|
31524
31620
|
"properties": {
|
|
31525
|
-
"Pattern": "A regular expression used to validate the value of a slot.\n\nUse a standard regular expression. Amazon Lex supports the following characters in the regular expression:\n\n- A-Z, a-z\n- 0-9\n- Unicode characters (\"\\u<Unicode>\")\n\nRepresent Unicode characters with four digits, for example \"
|
|
31621
|
+
"Pattern": "A regular expression used to validate the value of a slot.\n\nUse a standard regular expression. Amazon Lex supports the following characters in the regular expression:\n\n- A-Z, a-z\n- 0-9\n- Unicode characters (\"\\u<Unicode>\")\n\nRepresent Unicode characters with four digits, for example \"\\u0041\" or \"\\u005A\".\n\nThe following regular expression operators are not supported:\n\n- Infinite repeaters: *, +, or {x,} with no upper bound.\n- Wild card (.)"
|
|
31526
31622
|
}
|
|
31527
31623
|
},
|
|
31528
31624
|
"AWS::Lex::Bot.SlotValueSelectionSetting": {
|
|
31529
31625
|
"attributes": {},
|
|
31530
31626
|
"description": "Contains settings used by Amazon Lex to select a slot value.",
|
|
31531
31627
|
"properties": {
|
|
31532
|
-
"AdvancedRecognitionSetting": "
|
|
31628
|
+
"AdvancedRecognitionSetting": "Provides settings that enable advanced recognition settings for slot values.",
|
|
31533
31629
|
"RegexFilter": "A regular expression used to validate the value of a slot.",
|
|
31534
|
-
"ResolutionStrategy": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n-
|
|
31630
|
+
"ResolutionStrategy": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.\n- `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."
|
|
31535
31631
|
}
|
|
31536
31632
|
},
|
|
31537
31633
|
"AWS::Lex::Bot.StillWaitingResponseSpecification": {
|
|
@@ -31540,7 +31636,7 @@
|
|
|
31540
31636
|
"properties": {
|
|
31541
31637
|
"AllowInterrupt": "Indicates that the user can interrupt the response by speaking while the message is being played.",
|
|
31542
31638
|
"FrequencyInSeconds": "How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.",
|
|
31543
|
-
"MessageGroupsList": "
|
|
31639
|
+
"MessageGroupsList": "One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.",
|
|
31544
31640
|
"TimeoutInSeconds": "If Amazon Lex waits longer than this length of time for a response, it will stop sending messages."
|
|
31545
31641
|
}
|
|
31546
31642
|
},
|
|
@@ -31556,32 +31652,32 @@
|
|
|
31556
31652
|
},
|
|
31557
31653
|
"AWS::Lex::Bot.TextInputSpecification": {
|
|
31558
31654
|
"attributes": {},
|
|
31559
|
-
"description": "",
|
|
31655
|
+
"description": "Specifies the text input specifications.",
|
|
31560
31656
|
"properties": {
|
|
31561
|
-
"StartTimeoutMs": ""
|
|
31657
|
+
"StartTimeoutMs": "Time for which a bot waits before re-prompting a customer for text input."
|
|
31562
31658
|
}
|
|
31563
31659
|
},
|
|
31564
31660
|
"AWS::Lex::Bot.TextLogDestination": {
|
|
31565
31661
|
"attributes": {},
|
|
31566
|
-
"description": "
|
|
31662
|
+
"description": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.",
|
|
31567
31663
|
"properties": {
|
|
31568
|
-
"CloudWatch": "
|
|
31664
|
+
"CloudWatch": "Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered."
|
|
31569
31665
|
}
|
|
31570
31666
|
},
|
|
31571
31667
|
"AWS::Lex::Bot.TextLogSetting": {
|
|
31572
31668
|
"attributes": {},
|
|
31573
|
-
"description": "
|
|
31669
|
+
"description": "Defines settings to enable text conversation logs.",
|
|
31574
31670
|
"properties": {
|
|
31575
31671
|
"Destination": "Specifies the Amazon CloudWatch Logs destination log group for conversation text logs.",
|
|
31576
|
-
"Enabled": "
|
|
31672
|
+
"Enabled": "Determines whether conversation logs should be stored for an alias."
|
|
31577
31673
|
}
|
|
31578
31674
|
},
|
|
31579
31675
|
"AWS::Lex::Bot.VoiceSettings": {
|
|
31580
31676
|
"attributes": {},
|
|
31581
|
-
"description": "
|
|
31677
|
+
"description": "Defines settings for using an Amazon Polly voice to communicate with a user.",
|
|
31582
31678
|
"properties": {
|
|
31583
|
-
"Engine": "",
|
|
31584
|
-
"VoiceId": "The
|
|
31679
|
+
"Engine": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide* .\n\nIf you do not specify a value, the default is `standard` .",
|
|
31680
|
+
"VoiceId": "The identifier of the Amazon Polly voice to use."
|
|
31585
31681
|
}
|
|
31586
31682
|
},
|
|
31587
31683
|
"AWS::Lex::Bot.WaitAndContinueSpecification": {
|
|
@@ -31589,7 +31685,7 @@
|
|
|
31589
31685
|
"description": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.",
|
|
31590
31686
|
"properties": {
|
|
31591
31687
|
"ContinueResponse": "The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.",
|
|
31592
|
-
"IsActive": "Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used
|
|
31688
|
+
"IsActive": "Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the `IsActive` field isn't specified, the default is true.",
|
|
31593
31689
|
"StillWaitingResponse": "A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.",
|
|
31594
31690
|
"WaitingResponse": "The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue."
|
|
31595
31691
|
}
|
|
@@ -31602,7 +31698,7 @@
|
|
|
31602
31698
|
},
|
|
31603
31699
|
"description": "> Amazon Lex V2 is the only supported version in AWS CloudFormation . \n\nSpecifies an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.\n\nFor example, you can specify an alias called \"PROD\" that your applications use to call the Amazon Lex bot.",
|
|
31604
31700
|
"properties": {
|
|
31605
|
-
"BotAliasLocaleSettings": "
|
|
31701
|
+
"BotAliasLocaleSettings": "",
|
|
31606
31702
|
"BotAliasName": "The name of the bot alias.",
|
|
31607
31703
|
"BotAliasTags": "An array of key-value pairs to apply to this resource.\n\nYou can only add tags when you specify an alias.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
|
31608
31704
|
"BotId": "The unique identifier of the bot.",
|
|
@@ -31632,7 +31728,7 @@
|
|
|
31632
31728
|
"description": "Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.",
|
|
31633
31729
|
"properties": {
|
|
31634
31730
|
"CodeHookSpecification": "Specifies the Lambda function that should be used in the locale.",
|
|
31635
|
-
"Enabled": "Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use."
|
|
31731
|
+
"Enabled": "Determines whether the locale is enabled for the bot. If the value is `false` , the locale isn't available for use."
|
|
31636
31732
|
}
|
|
31637
31733
|
},
|
|
31638
31734
|
"AWS::Lex::BotAlias.BotAliasLocaleSettingsItem": {
|
|
@@ -31648,7 +31744,7 @@
|
|
|
31648
31744
|
"description": "The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.",
|
|
31649
31745
|
"properties": {
|
|
31650
31746
|
"CloudWatchLogGroupArn": "The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.",
|
|
31651
|
-
"LogPrefix": "The prefix of the log stream name within the log group that you specified
|
|
31747
|
+
"LogPrefix": "The prefix of the log stream name within the log group that you specified"
|
|
31652
31748
|
}
|
|
31653
31749
|
},
|
|
31654
31750
|
"AWS::Lex::BotAlias.CodeHookSpecification": {
|
|
@@ -31678,16 +31774,16 @@
|
|
|
31678
31774
|
"attributes": {},
|
|
31679
31775
|
"description": "Specifies an Amazon S3 bucket for logging audio conversations",
|
|
31680
31776
|
"properties": {
|
|
31681
|
-
"KmsKeyArn": "The Amazon Resource Name (ARN) of an AWS Key Management Service key for encrypting audio log files stored in an S3 bucket.",
|
|
31777
|
+
"KmsKeyArn": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.",
|
|
31682
31778
|
"LogPrefix": "The S3 prefix to assign to audio log files.",
|
|
31683
31779
|
"S3BucketArn": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored."
|
|
31684
31780
|
}
|
|
31685
31781
|
},
|
|
31686
31782
|
"AWS::Lex::BotAlias.SentimentAnalysisSettings": {
|
|
31687
31783
|
"attributes": {},
|
|
31688
|
-
"description": "",
|
|
31784
|
+
"description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.",
|
|
31689
31785
|
"properties": {
|
|
31690
|
-
"DetectSentiment": ""
|
|
31786
|
+
"DetectSentiment": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances."
|
|
31691
31787
|
}
|
|
31692
31788
|
},
|
|
31693
31789
|
"AWS::Lex::BotAlias.TextLogDestination": {
|
|
@@ -31699,7 +31795,7 @@
|
|
|
31699
31795
|
},
|
|
31700
31796
|
"AWS::Lex::BotAlias.TextLogSetting": {
|
|
31701
31797
|
"attributes": {},
|
|
31702
|
-
"description": "Defines settings to enable conversation logs.",
|
|
31798
|
+
"description": "Defines settings to enable text conversation logs.",
|
|
31703
31799
|
"properties": {
|
|
31704
31800
|
"Destination": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.",
|
|
31705
31801
|
"Enabled": "Determines whether conversation logs should be stored for an alias."
|
|
@@ -36740,26 +36836,6 @@
|
|
|
36740
36836
|
"Tags": "The list of key-value tags that changed for the segment."
|
|
36741
36837
|
}
|
|
36742
36838
|
},
|
|
36743
|
-
"AWS::NetworkManager::TransitGatewayPeering": {
|
|
36744
|
-
"attributes": {
|
|
36745
|
-
"CoreNetworkArn": "The ARN of the core network.",
|
|
36746
|
-
"CreatedAt": "The timestamp when the core network peering was created.",
|
|
36747
|
-
"EdgeLocation": "The edge location for the peer.",
|
|
36748
|
-
"OwnerAccountId": "The ID of the account owner.",
|
|
36749
|
-
"PeeringId": "The ID of the peering.",
|
|
36750
|
-
"PeeringType": "The peering type. This will be `TRANSIT_GATEWAY` .",
|
|
36751
|
-
"Ref": "`Ref` returns the `peeringId` . For example: `peering-01234ab1234a12a12` .",
|
|
36752
|
-
"ResourceArn": "The ARN of the resource peered to a core network.",
|
|
36753
|
-
"State": "The current state of the peer. This can be `CREATING` | `FAILED` | `AVAILABLE` | `DELETING` .",
|
|
36754
|
-
"TransitGatewayPeeringAttachmentId": "The ID of the peering attachment."
|
|
36755
|
-
},
|
|
36756
|
-
"description": "Creates a transit gateway peering connection.",
|
|
36757
|
-
"properties": {
|
|
36758
|
-
"CoreNetworkId": "The ID of the core network.",
|
|
36759
|
-
"Tags": "The list of key-value tags associated with the peering.",
|
|
36760
|
-
"TransitGatewayArn": "The ARN of the transit gateway."
|
|
36761
|
-
}
|
|
36762
|
-
},
|
|
36763
36839
|
"AWS::NetworkManager::TransitGatewayRegistration": {
|
|
36764
36840
|
"attributes": {
|
|
36765
36841
|
"Ref": "`Ref` returns the ID of the global network and the ARN of the transit gateway. For example: `global-network-01231231231231231|arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc` ."
|
|
@@ -37038,6 +37114,185 @@
|
|
|
37038
37114
|
"Tags": "An array of key-value pairs to apply to the sink.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
37039
37115
|
}
|
|
37040
37116
|
},
|
|
37117
|
+
"AWS::Omics::AnnotationStore": {
|
|
37118
|
+
"attributes": {
|
|
37119
|
+
"CreationTime": "When the store was created.",
|
|
37120
|
+
"Id": "The store's ID.",
|
|
37121
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"AnnotationStore.Id\" }` `Ref` returns the id for the annotation store.",
|
|
37122
|
+
"Status": "The store's status.",
|
|
37123
|
+
"StatusMessage": "The store's status message.",
|
|
37124
|
+
"StoreArn": "The store's ARN.",
|
|
37125
|
+
"StoreSizeBytes": "The store's size in bytes.",
|
|
37126
|
+
"UpdateTime": "When the store was updated."
|
|
37127
|
+
},
|
|
37128
|
+
"description": "Creates an annotation store.",
|
|
37129
|
+
"properties": {
|
|
37130
|
+
"Description": "A description for the store.",
|
|
37131
|
+
"Name": "The name of the Annotation Store.",
|
|
37132
|
+
"Reference": "The genome reference for the store's annotations.",
|
|
37133
|
+
"SseConfig": "The store's server-side encryption (SSE) settings.",
|
|
37134
|
+
"StoreFormat": "The annotation file format of the store.",
|
|
37135
|
+
"StoreOptions": "File parsing options for the annotation store.",
|
|
37136
|
+
"Tags": "Tags for the store."
|
|
37137
|
+
}
|
|
37138
|
+
},
|
|
37139
|
+
"AWS::Omics::AnnotationStore.ReferenceItem": {
|
|
37140
|
+
"attributes": {},
|
|
37141
|
+
"description": "A genome reference.",
|
|
37142
|
+
"properties": {
|
|
37143
|
+
"ReferenceArn": "The reference's ARN."
|
|
37144
|
+
}
|
|
37145
|
+
},
|
|
37146
|
+
"AWS::Omics::AnnotationStore.SseConfig": {
|
|
37147
|
+
"attributes": {},
|
|
37148
|
+
"description": "Server-side encryption (SSE) settings for a store.",
|
|
37149
|
+
"properties": {
|
|
37150
|
+
"KeyArn": "An encryption key ARN.",
|
|
37151
|
+
"Type": "The encryption type."
|
|
37152
|
+
}
|
|
37153
|
+
},
|
|
37154
|
+
"AWS::Omics::AnnotationStore.StoreOptions": {
|
|
37155
|
+
"attributes": {},
|
|
37156
|
+
"description": "The store's file parsing options.",
|
|
37157
|
+
"properties": {
|
|
37158
|
+
"TsvStoreOptions": "Formatting options for a TSV file."
|
|
37159
|
+
}
|
|
37160
|
+
},
|
|
37161
|
+
"AWS::Omics::AnnotationStore.TsvStoreOptions": {
|
|
37162
|
+
"attributes": {},
|
|
37163
|
+
"description": "The store's parsing options.",
|
|
37164
|
+
"properties": {
|
|
37165
|
+
"AnnotationType": "The store's annotation type.",
|
|
37166
|
+
"FormatToHeader": "The store's header key to column name mapping.",
|
|
37167
|
+
"Schema": "The schema of an annotation store."
|
|
37168
|
+
}
|
|
37169
|
+
},
|
|
37170
|
+
"AWS::Omics::ReferenceStore": {
|
|
37171
|
+
"attributes": {
|
|
37172
|
+
"Arn": "",
|
|
37173
|
+
"CreationTime": "When the store was created.",
|
|
37174
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"ReferenceStore.Arn\" }` `Ref` returns the arn for the reference store.",
|
|
37175
|
+
"ReferenceStoreId": "The store's ID."
|
|
37176
|
+
},
|
|
37177
|
+
"description": "Creates a reference store.",
|
|
37178
|
+
"properties": {
|
|
37179
|
+
"Description": "A description for the store.",
|
|
37180
|
+
"Name": "A name for the store.",
|
|
37181
|
+
"SseConfig": "Server-side encryption (SSE) settings for the store.",
|
|
37182
|
+
"Tags": "Tags for the store."
|
|
37183
|
+
}
|
|
37184
|
+
},
|
|
37185
|
+
"AWS::Omics::ReferenceStore.SseConfig": {
|
|
37186
|
+
"attributes": {},
|
|
37187
|
+
"description": "Server-side encryption (SSE) settings for a store.",
|
|
37188
|
+
"properties": {
|
|
37189
|
+
"KeyArn": "An encryption key ARN.",
|
|
37190
|
+
"Type": "The encryption type."
|
|
37191
|
+
}
|
|
37192
|
+
},
|
|
37193
|
+
"AWS::Omics::RunGroup": {
|
|
37194
|
+
"attributes": {
|
|
37195
|
+
"Arn": "The run group's ARN.",
|
|
37196
|
+
"CreationTime": "When the run group was created.",
|
|
37197
|
+
"Id": "The run group's ID.",
|
|
37198
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"RunGroup.CreationTime\" }` `Ref` returns the timestamp for a run group."
|
|
37199
|
+
},
|
|
37200
|
+
"description": "Creates a run group.",
|
|
37201
|
+
"properties": {
|
|
37202
|
+
"MaxCpus": "The group's maximum CPU count setting.",
|
|
37203
|
+
"MaxDuration": "The group's maximum duration setting in minutes.",
|
|
37204
|
+
"MaxRuns": "The group's maximum concurrent run setting.",
|
|
37205
|
+
"Name": "The group's name.",
|
|
37206
|
+
"Tags": "Tags for the group."
|
|
37207
|
+
}
|
|
37208
|
+
},
|
|
37209
|
+
"AWS::Omics::SequenceStore": {
|
|
37210
|
+
"attributes": {
|
|
37211
|
+
"Arn": "The store's ARN.",
|
|
37212
|
+
"CreationTime": "When the store was created.",
|
|
37213
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"SequenceStore.CreationTime\" }` `Ref` returns the timestamp for when the sequence store was created.",
|
|
37214
|
+
"SequenceStoreId": "The store's ID."
|
|
37215
|
+
},
|
|
37216
|
+
"description": "Creates a sequence store.",
|
|
37217
|
+
"properties": {
|
|
37218
|
+
"Description": "A description for the store.",
|
|
37219
|
+
"Name": "A name for the store.",
|
|
37220
|
+
"SseConfig": "Server-side encryption (SSE) settings for the store.",
|
|
37221
|
+
"Tags": "Tags for the store."
|
|
37222
|
+
}
|
|
37223
|
+
},
|
|
37224
|
+
"AWS::Omics::SequenceStore.SseConfig": {
|
|
37225
|
+
"attributes": {},
|
|
37226
|
+
"description": "Server-side encryption (SSE) settings for a store.",
|
|
37227
|
+
"properties": {
|
|
37228
|
+
"KeyArn": "An encryption key ARN.",
|
|
37229
|
+
"Type": "The encryption type."
|
|
37230
|
+
}
|
|
37231
|
+
},
|
|
37232
|
+
"AWS::Omics::VariantStore": {
|
|
37233
|
+
"attributes": {
|
|
37234
|
+
"CreationTime": "When the store was created.",
|
|
37235
|
+
"Id": "The store's ID.",
|
|
37236
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"VariantStore.Status\" }`\n\nFor the Amazon Omics resource `VariantStore.Status` , `Ref` returns the status of the variant store.",
|
|
37237
|
+
"Status": "The store's status.",
|
|
37238
|
+
"StatusMessage": "The store's status message.",
|
|
37239
|
+
"StoreArn": "The store's ARN.",
|
|
37240
|
+
"StoreSizeBytes": "The store's size in bytes.",
|
|
37241
|
+
"UpdateTime": "When the store was updated."
|
|
37242
|
+
},
|
|
37243
|
+
"description": "Create a store for variant data.",
|
|
37244
|
+
"properties": {
|
|
37245
|
+
"Description": "A description for the store.",
|
|
37246
|
+
"Name": "A name for the store.",
|
|
37247
|
+
"Reference": "The genome reference for the store's variants.",
|
|
37248
|
+
"SseConfig": "Server-side encryption (SSE) settings for the store.",
|
|
37249
|
+
"Tags": "Tags for the store."
|
|
37250
|
+
}
|
|
37251
|
+
},
|
|
37252
|
+
"AWS::Omics::VariantStore.ReferenceItem": {
|
|
37253
|
+
"attributes": {},
|
|
37254
|
+
"description": "The read set's genome reference ARN.",
|
|
37255
|
+
"properties": {
|
|
37256
|
+
"ReferenceArn": "The reference's ARN."
|
|
37257
|
+
}
|
|
37258
|
+
},
|
|
37259
|
+
"AWS::Omics::VariantStore.SseConfig": {
|
|
37260
|
+
"attributes": {},
|
|
37261
|
+
"description": "Server-side encryption (SSE) settings for a store.",
|
|
37262
|
+
"properties": {
|
|
37263
|
+
"KeyArn": "An encryption key ARN.",
|
|
37264
|
+
"Type": "The encryption type."
|
|
37265
|
+
}
|
|
37266
|
+
},
|
|
37267
|
+
"AWS::Omics::Workflow": {
|
|
37268
|
+
"attributes": {
|
|
37269
|
+
"Arn": "The ARN for the workflow.",
|
|
37270
|
+
"CreationTime": "When the workflow was created.",
|
|
37271
|
+
"Id": "The workflow's ID.",
|
|
37272
|
+
"Ref": "`Ref` returns the details of this resource. For example:\n\n`{ \"Ref\": \"Workflow.Type\" }` `Ref` returns the type of workflow.",
|
|
37273
|
+
"Status": "The workflow's status.",
|
|
37274
|
+
"Type": "The workflow's type."
|
|
37275
|
+
},
|
|
37276
|
+
"description": "Creates a workflow.",
|
|
37277
|
+
"properties": {
|
|
37278
|
+
"DefinitionUri": "The URI of a definition for the workflow.",
|
|
37279
|
+
"Description": "The parameter's description.",
|
|
37280
|
+
"Engine": "An engine for the workflow.",
|
|
37281
|
+
"Main": "The path of the main definition file for the workflow.",
|
|
37282
|
+
"Name": "The workflow's name.",
|
|
37283
|
+
"ParameterTemplate": "The workflow's parameter template.",
|
|
37284
|
+
"StorageCapacity": "A storage capacity for the workflow in gigabytes.",
|
|
37285
|
+
"Tags": "Tags for the workflow."
|
|
37286
|
+
}
|
|
37287
|
+
},
|
|
37288
|
+
"AWS::Omics::Workflow.WorkflowParameter": {
|
|
37289
|
+
"attributes": {},
|
|
37290
|
+
"description": "A workflow parameter.",
|
|
37291
|
+
"properties": {
|
|
37292
|
+
"Description": "The parameter's description.",
|
|
37293
|
+
"Optional": "Whether the parameter is optional."
|
|
37294
|
+
}
|
|
37295
|
+
},
|
|
37041
37296
|
"AWS::OpenSearchServerless::AccessPolicy": {
|
|
37042
37297
|
"attributes": {
|
|
37043
37298
|
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the access policy. For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
@@ -37681,7 +37936,7 @@
|
|
|
37681
37936
|
"Email": "The email address associated with the AWS account.\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) for this parameter is a string of characters that represents a standard internet email address.",
|
|
37682
37937
|
"ParentIds": "The unique identifier (ID) of the root or organizational unit (OU) that you want to create the new account in. If you don't specify this parameter, the `ParentId` defaults to the root ID.\n\nThis parameter only accepts a string array with one string value.\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following:\n\n- *Root* - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.\n- *Organizational unit (OU)* - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.",
|
|
37683
37938
|
"RoleName": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.\n\nIf you don't specify this parameter, the role name defaults to `OrganizationAccountAccessRole` .\n\nFor more information about how to use this role to access the member account, see the following links:\n\n- [Accessing and Administering the Member Accounts in Your Organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) in the *AWS Organizations User Guide*\n- Steps 2 and 3 in [Tutorial: Delegate Access Across AWS accounts Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the *IAM User Guide*\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-",
|
|
37684
|
-
"Tags": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is
|
|
37939
|
+
"Tags": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created."
|
|
37685
37940
|
}
|
|
37686
37941
|
},
|
|
37687
37942
|
"AWS::Organizations::OrganizationalUnit": {
|
|
@@ -37694,7 +37949,7 @@
|
|
|
37694
37949
|
"properties": {
|
|
37695
37950
|
"Name": "The friendly name of this OU.\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range.",
|
|
37696
37951
|
"ParentId": "The unique identifier (ID) of the parent root or OU that you want to create the new OU in.\n\n> To update the `ParentId` parameter value, you must first remove all accounts attached to the organizational unit (OU). OUs can't be moved within the organization with accounts still attached. \n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following:\n\n- *Root* - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.\n- *Organizational unit (OU)* - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.",
|
|
37697
|
-
"Tags": "A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is
|
|
37952
|
+
"Tags": "A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created."
|
|
37698
37953
|
}
|
|
37699
37954
|
},
|
|
37700
37955
|
"AWS::Organizations::Policy": {
|
|
@@ -37709,7 +37964,7 @@
|
|
|
37709
37964
|
"Content": "The policy text content.",
|
|
37710
37965
|
"Description": "Human readable description of the policy.",
|
|
37711
37966
|
"Name": "Name of the policy.\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range.",
|
|
37712
|
-
"Tags": "A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is
|
|
37967
|
+
"Tags": "A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null` . For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n\n> If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.",
|
|
37713
37968
|
"TargetIds": "List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the [ListRoots](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html) , [ListOrganizationalUnitsForParent](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListOrganizationalUnitsForParent.html) , or [ListAccounts](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) operations. If you don't specify this parameter, the policy is created but not attached to any organization resource.\n\nThe [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) for a target ID string requires one of the following:\n\n- *Root* - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.\n- *Account* - A string that consists of exactly 12 digits.\n- *Organizational unit (OU)* - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.",
|
|
37714
37969
|
"Type": "The type of policy to create."
|
|
37715
37970
|
}
|
|
@@ -39243,7 +39498,7 @@
|
|
|
39243
39498
|
"description": "The parameters for using an EventBridge event bus as a target.",
|
|
39244
39499
|
"properties": {
|
|
39245
39500
|
"DetailType": "A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.",
|
|
39246
|
-
"EndpointId": "The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is `abcde.veo`
|
|
39501
|
+
"EndpointId": "The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is `abcde.veo` .",
|
|
39247
39502
|
"Resources": "AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.",
|
|
39248
39503
|
"Source": "The source of the event.",
|
|
39249
39504
|
"Time": "The time stamp of the event, per [RFC3339](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc3339.txt) . If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used."
|
|
@@ -39411,7 +39666,7 @@
|
|
|
39411
39666
|
"DataSetArns": "The ARNs of the datasets of the analysis.",
|
|
39412
39667
|
"LastUpdatedTime": "The time that the analysis was last updated."
|
|
39413
39668
|
},
|
|
39414
|
-
"description": "Creates an analysis in Amazon QuickSight.",
|
|
39669
|
+
"description": "Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an `AnalysisDefinition` .",
|
|
39415
39670
|
"properties": {
|
|
39416
39671
|
"AnalysisId": "The ID for the analysis that you're creating. This ID displays in the URL of the analysis.",
|
|
39417
39672
|
"AwsAccountId": "The ID of the AWS account where you are creating an analysis.",
|
|
@@ -39419,7 +39674,7 @@
|
|
|
39419
39674
|
"Name": "A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.",
|
|
39420
39675
|
"Parameters": "The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.",
|
|
39421
39676
|
"Permissions": "A structure that describes the principals and the resource-level permissions on an analysis. You can use the `Permissions` structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).\n\nTo specify no permissions, omit `Permissions` .",
|
|
39422
|
-
"SourceEntity": "A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.",
|
|
39677
|
+
"SourceEntity": "A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.\n\nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid.",
|
|
39423
39678
|
"Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.",
|
|
39424
39679
|
"ThemeArn": "The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it."
|
|
39425
39680
|
}
|
|
@@ -40230,12 +40485,12 @@
|
|
|
40230
40485
|
"Version.ThemeArn": "",
|
|
40231
40486
|
"Version.VersionNumber": ""
|
|
40232
40487
|
},
|
|
40233
|
-
"description": "Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create
|
|
40488
|
+
"description": "Creates a template either from a `TemplateDefinition` or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.\n\nA *template* is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.",
|
|
40234
40489
|
"properties": {
|
|
40235
40490
|
"AwsAccountId": "The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.",
|
|
40236
40491
|
"Name": "A display name for the template.",
|
|
40237
40492
|
"Permissions": "A list of resource permissions to be set on the template.",
|
|
40238
|
-
"SourceEntity": "The entity that you are using as a source when you create the template. In `SourceEntity` , you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate` , specify the ARN of the source template. For `SourceAnalysis` , specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region .\n\nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.",
|
|
40493
|
+
"SourceEntity": "The entity that you are using as a source when you create the template. In `SourceEntity` , you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate` , specify the ARN of the source template. For `SourceAnalysis` , specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region .\n\nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.\n\nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid.",
|
|
40239
40494
|
"Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.",
|
|
40240
40495
|
"TemplateId": "An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.",
|
|
40241
40496
|
"VersionDescription": "A description of the current template version being created. This API operation creates the first version of the template. Every time `UpdateTemplate` is called, a new version is created. Each version of the template maintains a description of the version in the `VersionDescription` field."
|
|
@@ -40686,7 +40941,7 @@
|
|
|
40686
40941
|
"CopyTagsToSnapshot": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\n\n*Amazon Aurora*\n\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.",
|
|
40687
40942
|
"CustomIAMInstanceProfile": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:\n\n- The profile must exist in your account.\n- The profile must have an IAM role that Amazon EC2 has permissions to assume.\n- The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom` .\n\nFor the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide* .\n\nThis setting is required for RDS Custom.",
|
|
40688
40943
|
"DBClusterIdentifier": "The identifier of the DB cluster that the instance will belong to.",
|
|
40689
|
-
"DBClusterSnapshotIdentifier": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.\n\nFor more information on Multi-AZ DB clusters, see [Multi-AZ
|
|
40944
|
+
"DBClusterSnapshotIdentifier": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.\n\nFor more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide* .\n\nConstraints:\n\n- Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n- Can't be specified when `DBSnapshotIdentifier` is specified.\n- Must be specified when `DBSnapshotIdentifier` isn't specified.\n- If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot.\n- Can't be the identifier of an Aurora DB cluster snapshot.\n- Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.",
|
|
40690
40945
|
"DBInstanceClass": "The compute and memory capacity of the DB instance, for example, `db.m4.large` . Not all DB instance classes are available in all AWS Regions, or for all database engines.\n\nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/) .",
|
|
40691
40946
|
"DBInstanceIdentifier": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide* .\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
|
|
40692
40947
|
"DBName": "The meaning of this parameter differs according to the database engine you use.\n\n> If you specify the `[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle. \n\n*Amazon Aurora*\n\nNot applicable. The database name is managed by the DB cluster.\n\n*MySQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*MariaDB*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*PostgreSQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, the default `postgres` database is created in the DB instance.\n\nConstraints:\n\n- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n- Must contain 1 to 63 characters.\n- Can't be a word reserved by the specified database engine\n\n*Oracle*\n\nThe Oracle System ID (SID) of the created DB instance. If you specify `null` , the default value `ORCL` is used. You can't specify the string NULL, or any other reserved word, for `DBName` .\n\nDefault: `ORCL`\n\nConstraints:\n\n- Can't be longer than 8 characters\n\n*SQL Server*\n\nNot applicable. Must be null.",
|
|
@@ -41098,7 +41353,7 @@
|
|
|
41098
41353
|
"MaintenanceTrackName": "An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the `current` track.",
|
|
41099
41354
|
"ManualSnapshotRetentionPeriod": "The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.\n\nThe value must be either -1 or an integer between 1 and 3,653.",
|
|
41100
41355
|
"MasterUserPassword": "The password associated with the admin user account for the cluster that is being created.\n\nConstraints:\n\n- Must be between 8 and 64 characters in length.\n- Must contain at least one uppercase letter.\n- Must contain at least one lowercase letter.\n- Must contain one number.\n- Can be any printable ASCII character (ASCII code 33-126) except `'` (single quote), `\"` (double quote), `\\` , `/` , or `@` .",
|
|
41101
|
-
"MasterUsername": "The user name associated with the admin user account for the cluster that is being created.\n\nConstraints:\n\n- Must be 1 - 128 alphanumeric characters. The user name can't be `PUBLIC` .\n-
|
|
41356
|
+
"MasterUsername": "The user name associated with the admin user account for the cluster that is being created.\n\nConstraints:\n\n- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be `PUBLIC` .\n- Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.\n- The first character must be a letter.\n- Must not contain a colon (:) or a slash (/).\n- Cannot be a reserved word. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.",
|
|
41102
41357
|
"NodeType": "The node type to be provisioned for the cluster. For information about node types, go to [Working with Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide* .\n\nValid Values: `ds2.xlarge` | `ds2.8xlarge` | `dc1.large` | `dc1.8xlarge` | `dc2.large` | `dc2.8xlarge` | `ra3.xlplus` | `ra3.4xlarge` | `ra3.16xlarge`",
|
|
41103
41358
|
"NumberOfNodes": "The number of compute nodes in the cluster. This parameter is required when the *ClusterType* parameter is specified as `multi-node` .\n\nFor information about determining how many nodes you need, go to [Working with Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide* .\n\nIf you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.\n\nDefault: `1`\n\nConstraints: Value must be at least 1 and no more than 100.",
|
|
41104
41359
|
"OwnerAccount": "The AWS account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.",
|
|
@@ -41112,7 +41367,7 @@
|
|
|
41112
41367
|
"SnapshotCopyGrantName": "The name of the snapshot copy grant.",
|
|
41113
41368
|
"SnapshotCopyManual": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.",
|
|
41114
41369
|
"SnapshotCopyRetentionPeriod": "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .\n\nBy default, this only changes the retention period of copied automated snapshots.\n\nIf you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.\n\nConstraints: Must be at least 1 and no more than 35 for automated snapshots.\n\nIf you specify the `manual` option, only newly copied manual snapshots will have the new retention period.\n\nIf you specify the value of -1 newly copied manual snapshots are retained indefinitely.\n\nConstraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.",
|
|
41115
|
-
"SnapshotIdentifier": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You
|
|
41370
|
+
"SnapshotIdentifier": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or `snapshotArn` , but not both.\n\nExample: `my-snapshot-id`",
|
|
41116
41371
|
"Tags": "A list of tag instances.",
|
|
41117
41372
|
"VpcSecurityGroupIds": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.\n\nDefault: The default VPC security group is associated with the cluster."
|
|
41118
41373
|
}
|
|
@@ -41247,7 +41502,7 @@
|
|
|
41247
41502
|
},
|
|
41248
41503
|
"description": "Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts .",
|
|
41249
41504
|
"properties": {
|
|
41250
|
-
"Account": "The
|
|
41505
|
+
"Account": "The AWS account ID of either the cluster owner (grantor) or grantee. If `Grantee` parameter is true, then the `Account` value is of the grantor.",
|
|
41251
41506
|
"ClusterIdentifier": "The cluster identifier.",
|
|
41252
41507
|
"Force": "Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.",
|
|
41253
41508
|
"VpcIds": "The virtual private cloud (VPC) identifiers to grant access to."
|
|
@@ -41983,42 +42238,42 @@
|
|
|
41983
42238
|
"AWS::RolesAnywhere::CRL": {
|
|
41984
42239
|
"attributes": {
|
|
41985
42240
|
"CrlId": "The unique primary identifier of the Crl",
|
|
41986
|
-
"Ref": "
|
|
42241
|
+
"Ref": "`Ref` returns `CrlId` ."
|
|
41987
42242
|
},
|
|
41988
|
-
"description": "
|
|
42243
|
+
"description": "The state of the certificate revocation list (CRL) after a read or write operation.",
|
|
41989
42244
|
"properties": {
|
|
41990
|
-
"CrlData": "
|
|
41991
|
-
"Enabled": "
|
|
41992
|
-
"Name": "The
|
|
41993
|
-
"Tags": "A list of
|
|
42245
|
+
"CrlData": "The revocation record for a certificate, following the x509 v3 standard.",
|
|
42246
|
+
"Enabled": "Indicates whether the certificate revocation list (CRL) is enabled.",
|
|
42247
|
+
"Name": "The name of the certificate revocation list (CRL).",
|
|
42248
|
+
"Tags": "A list of tags to attach to the CRL.",
|
|
41994
42249
|
"TrustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for."
|
|
41995
42250
|
}
|
|
41996
42251
|
},
|
|
41997
42252
|
"AWS::RolesAnywhere::Profile": {
|
|
41998
42253
|
"attributes": {
|
|
41999
|
-
"ProfileArn": "",
|
|
42254
|
+
"ProfileArn": "The ARN of the profile.",
|
|
42000
42255
|
"ProfileId": "The unique primary identifier of the Profile",
|
|
42001
|
-
"Ref": "
|
|
42256
|
+
"Ref": "`Ref` returns `ProfileId` ."
|
|
42002
42257
|
},
|
|
42003
|
-
"description": "Creates a
|
|
42258
|
+
"description": "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.\n\n*Required permissions:* `rolesanywhere:CreateProfile` .",
|
|
42004
42259
|
"properties": {
|
|
42005
|
-
"DurationSeconds": "
|
|
42006
|
-
"Enabled": "
|
|
42007
|
-
"ManagedPolicyArns": "A list of managed policy ARNs
|
|
42008
|
-
"Name": "The
|
|
42009
|
-
"RequireInstanceProperties": "Specifies whether instance properties are required in
|
|
42010
|
-
"RoleArns": "A list of IAM role ARNs
|
|
42011
|
-
"SessionPolicy": "A session policy that
|
|
42012
|
-
"Tags": "A list of
|
|
42260
|
+
"DurationSeconds": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.",
|
|
42261
|
+
"Enabled": "Indicates whether the profile is enabled.",
|
|
42262
|
+
"ManagedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.",
|
|
42263
|
+
"Name": "The name of the profile.",
|
|
42264
|
+
"RequireInstanceProperties": "Specifies whether instance properties are required in temporary credential requests with this profile.",
|
|
42265
|
+
"RoleArns": "A list of IAM role ARNs. During `CreateSession` , if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy.",
|
|
42266
|
+
"SessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.",
|
|
42267
|
+
"Tags": "A list of tags to attach to the profile."
|
|
42013
42268
|
}
|
|
42014
42269
|
},
|
|
42015
42270
|
"AWS::RolesAnywhere::TrustAnchor": {
|
|
42016
42271
|
"attributes": {
|
|
42017
42272
|
"Ref": "`Ref` returns `TrustAnchorId` .",
|
|
42018
42273
|
"TrustAnchorArn": "The ARN of the trust anchor.",
|
|
42019
|
-
"TrustAnchorId": ""
|
|
42274
|
+
"TrustAnchorId": "The unique primary identifier of the TrustAnchor"
|
|
42020
42275
|
},
|
|
42021
|
-
"description": "
|
|
42276
|
+
"description": "The state of the trust anchor after a read or write operation.",
|
|
42022
42277
|
"properties": {
|
|
42023
42278
|
"Enabled": "Indicates whether the trust anchor is enabled.",
|
|
42024
42279
|
"Name": "The name of the trust anchor.",
|
|
@@ -42028,15 +42283,15 @@
|
|
|
42028
42283
|
},
|
|
42029
42284
|
"AWS::RolesAnywhere::TrustAnchor.Source": {
|
|
42030
42285
|
"attributes": {},
|
|
42031
|
-
"description": "
|
|
42286
|
+
"description": "The trust anchor type and its related certificate data.",
|
|
42032
42287
|
"properties": {
|
|
42033
|
-
"SourceData": "
|
|
42034
|
-
"SourceType": "The type of the
|
|
42288
|
+
"SourceData": "The data field of the trust anchor depending on its type.",
|
|
42289
|
+
"SourceType": "The type of the trust anchor."
|
|
42035
42290
|
}
|
|
42036
42291
|
},
|
|
42037
42292
|
"AWS::RolesAnywhere::TrustAnchor.SourceData": {
|
|
42038
42293
|
"attributes": {},
|
|
42039
|
-
"description": "
|
|
42294
|
+
"description": "The data field of the trust anchor depending on its type.",
|
|
42040
42295
|
"properties": {
|
|
42041
42296
|
"AcmPcaArn": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA` .",
|
|
42042
42297
|
"X509CertificateData": "The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` ."
|
|
@@ -45090,7 +45345,7 @@
|
|
|
45090
45345
|
"SingleSignOnManagedApplicationInstanceId": "The IAM Identity Center managed application instance ID.",
|
|
45091
45346
|
"Url": "The URL for the Domain."
|
|
45092
45347
|
},
|
|
45093
|
-
"description": "Creates a `Domain` used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations.
|
|
45348
|
+
"description": "Creates a `Domain` used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.\n\n*EFS storage*\n\nWhen a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.\n\nSageMaker uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see [Protect Data at Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) .\n\n*VPC configuration*\n\nAll SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds to the network access type that you choose when you onboard to Studio. The following options are available:\n\n- `PublicInternetOnly` - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.\n- `VpcOnly` - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.\n\nWhen internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.\n\n> NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully. \n\nFor more information, see [Connect SageMaker Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .",
|
|
45094
45349
|
"properties": {
|
|
45095
45350
|
"AppNetworkAccessType": "Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly` .\n\n- `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access\n- `VpcOnly` - All Studio traffic is through the specified VPC and subnets\n\n*Valid Values* : `PublicInternetOnly | VpcOnly`",
|
|
45096
45351
|
"AppSecurityGroupManagement": "The entity that creates and manages the required security groups for inter-app communication in `VpcOnly` mode. Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided.",
|
|
@@ -45489,7 +45744,7 @@
|
|
|
45489
45744
|
"DataCatalogConfig": "The meta data of the Glue table that is autogenerated when an `OfflineStore` is created.",
|
|
45490
45745
|
"DisableGlueTableCreation": "Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore` .",
|
|
45491
45746
|
"S3StorageConfig": "The Amazon Simple Storage (Amazon S3) location of `OfflineStore` .",
|
|
45492
|
-
"TableFormat": "
|
|
45747
|
+
"TableFormat": ""
|
|
45493
45748
|
}
|
|
45494
45749
|
},
|
|
45495
45750
|
"AWS::SageMaker::FeatureGroup.OnlineStoreConfig": {
|
|
@@ -45504,7 +45759,7 @@
|
|
|
45504
45759
|
"attributes": {},
|
|
45505
45760
|
"description": "The security configuration for `OnlineStore` .",
|
|
45506
45761
|
"properties": {
|
|
45507
|
-
"KmsKeyId": "The ID of the AWS Key Management Service ( AWS KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.\n\nThe caller (either IAM user or IAM role) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId` :\n\n- `\"kms:Encrypt\"`\n- `\"kms:Decrypt\"`\n- `\"kms:DescribeKey\"`\n- `\"kms:CreateGrant\"`\n- `\"kms:RetireGrant\"`\n- `\"kms:ReEncryptFrom\"`\n- `\"kms:ReEncryptTo\"`\n- `\"kms:GenerateDataKey\"`\n- `\"kms:ListAliases\"`\n- `\"kms:ListGrants\"`\n- `\"kms:RevokeGrant\"`\n\nThe caller (either
|
|
45762
|
+
"KmsKeyId": "The ID of the AWS Key Management Service ( AWS KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.\n\nThe caller (either IAM user or IAM role) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId` :\n\n- `\"kms:Encrypt\"`\n- `\"kms:Decrypt\"`\n- `\"kms:DescribeKey\"`\n- `\"kms:CreateGrant\"`\n- `\"kms:RetireGrant\"`\n- `\"kms:ReEncryptFrom\"`\n- `\"kms:ReEncryptTo\"`\n- `\"kms:GenerateDataKey\"`\n- `\"kms:ListAliases\"`\n- `\"kms:ListGrants\"`\n- `\"kms:RevokeGrant\"`\n\nThe caller (either user or IAM role) to all DataPlane operations ( `PutRecord` , `GetRecord` , `DeleteRecord` ) must have the following permissions to the `KmsKeyId` :\n\n- `\"kms:Decrypt\"`"
|
|
45508
45763
|
}
|
|
45509
45764
|
},
|
|
45510
45765
|
"AWS::SageMaker::FeatureGroup.S3StorageConfig": {
|
|
@@ -45570,7 +45825,7 @@
|
|
|
45570
45825
|
"ImageConfig": "Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see [Use a Private Docker Registry for Real-Time Inference Containers](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html)",
|
|
45571
45826
|
"InferenceSpecificationName": "The inference specification name in the model package version.",
|
|
45572
45827
|
"Mode": "Whether the container hosts a single model or multiple models.",
|
|
45573
|
-
"ModelDataUrl": "The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) .\n\n> The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating. \n\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your
|
|
45828
|
+
"ModelDataUrl": "The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) .\n\n> The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating. \n\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your AWS account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *AWS Identity and Access Management User Guide* .\n\n> If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl` .",
|
|
45574
45829
|
"ModelPackageName": "The name or Amazon Resource Name (ARN) of the model package to use to create the model.",
|
|
45575
45830
|
"MultiModelConfig": "Specifies additional configuration for multi-model endpoints."
|
|
45576
45831
|
}
|
|
@@ -45794,6 +46049,174 @@
|
|
|
45794
46049
|
"Subnets": "The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) ."
|
|
45795
46050
|
}
|
|
45796
46051
|
},
|
|
46052
|
+
"AWS::SageMaker::ModelCard": {
|
|
46053
|
+
"attributes": {
|
|
46054
|
+
"ModelCardArn": "The Amazon Resource Number (ARN) of the model card. For example, `arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard` .",
|
|
46055
|
+
"Ref": "`Ref` returns the model card name.\n\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
46056
|
+
},
|
|
46057
|
+
"description": "Creates an Amazon SageMaker Model Card.\n\nFor information about how to use model cards, see [Amazon SageMaker Model Card](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html) .",
|
|
46058
|
+
"properties": {
|
|
46059
|
+
"Content": "The content of the model card. Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .",
|
|
46060
|
+
"ModelCardName": "The unique name of the model card.",
|
|
46061
|
+
"ModelCardStatus": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.\n\n- `Draft` : The model card is a work in progress.\n- `PendingReview` : The model card is pending review.\n- `Approved` : The model card is approved.\n- `Archived` : The model card is archived. No more updates should be made to the model card, but it can still be exported.",
|
|
46062
|
+
"SecurityConfig": "The security configuration used to protect model card data.",
|
|
46063
|
+
"Tags": "Key-value pairs used to manage metadata for the model card."
|
|
46064
|
+
}
|
|
46065
|
+
},
|
|
46066
|
+
"AWS::SageMaker::ModelCard.AdditionalInformation": {
|
|
46067
|
+
"attributes": {},
|
|
46068
|
+
"description": "Additional information about the model.",
|
|
46069
|
+
"properties": {
|
|
46070
|
+
"CaveatsAndRecommendations": "Caveats and recommendations for those who might use this model in their applications.",
|
|
46071
|
+
"CustomDetails": "Any additional information to document about the model.",
|
|
46072
|
+
"EthicalConsiderations": "Any ethical considerations documented by the model card author."
|
|
46073
|
+
}
|
|
46074
|
+
},
|
|
46075
|
+
"AWS::SageMaker::ModelCard.BusinessDetails": {
|
|
46076
|
+
"attributes": {},
|
|
46077
|
+
"description": "Information about how the model supports business goals.",
|
|
46078
|
+
"properties": {
|
|
46079
|
+
"BusinessProblem": "The specific business problem that the model is trying to solve.",
|
|
46080
|
+
"BusinessStakeholders": "The relevant stakeholders for the model.",
|
|
46081
|
+
"LineOfBusiness": "The broader business need that the model is serving."
|
|
46082
|
+
}
|
|
46083
|
+
},
|
|
46084
|
+
"AWS::SageMaker::ModelCard.Content": {
|
|
46085
|
+
"attributes": {},
|
|
46086
|
+
"description": "The content of the model card. It follows the [model card json schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .",
|
|
46087
|
+
"properties": {
|
|
46088
|
+
"AdditionalInformation": "Additional information about the model.",
|
|
46089
|
+
"BusinessDetails": "Information about how the model supports business goals.",
|
|
46090
|
+
"EvaluationDetails": "An overview about the model's evaluation.",
|
|
46091
|
+
"IntendedUses": "The intended usage of the model.",
|
|
46092
|
+
"ModelOverview": "An overview about the model",
|
|
46093
|
+
"TrainingDetails": "An overview about model training."
|
|
46094
|
+
}
|
|
46095
|
+
},
|
|
46096
|
+
"AWS::SageMaker::ModelCard.EvaluationDetail": {
|
|
46097
|
+
"attributes": {},
|
|
46098
|
+
"description": "The evaluation details of the model.",
|
|
46099
|
+
"properties": {
|
|
46100
|
+
"Datasets": "The location of the datasets used to evaluate the model.",
|
|
46101
|
+
"EvaluationJobArn": "The Amazon Resource Name (ARN) of the evaluation job.",
|
|
46102
|
+
"EvaluationObservation": "Any observations made during the model evaluation.",
|
|
46103
|
+
"Metadata": "Additional attributes associated with the evaluation results.",
|
|
46104
|
+
"MetricGroups": "An evaluation Metric Group object.",
|
|
46105
|
+
"Name": "The evaluation job name."
|
|
46106
|
+
}
|
|
46107
|
+
},
|
|
46108
|
+
"AWS::SageMaker::ModelCard.Function": {
|
|
46109
|
+
"attributes": {},
|
|
46110
|
+
"description": "Function details.",
|
|
46111
|
+
"properties": {
|
|
46112
|
+
"Condition": "An optional description of any conditions of your objective function metric.",
|
|
46113
|
+
"Facet": "The metric of the model's objective function. For example, *loss* or *rmse* . The following list shows examples of the values that you can specify for the metric:\n\n- `ACCURACY`\n- `AUC`\n- `LOSS`\n- `MAE`\n- `RMSE`",
|
|
46114
|
+
"Function": "The optimization direction of the model's objective function. You must specify one of the following values:\n\n- `Maximize`\n- `Minimize`"
|
|
46115
|
+
}
|
|
46116
|
+
},
|
|
46117
|
+
"AWS::SageMaker::ModelCard.InferenceEnvironment": {
|
|
46118
|
+
"attributes": {},
|
|
46119
|
+
"description": "An overview of a model's inference environment.",
|
|
46120
|
+
"properties": {
|
|
46121
|
+
"ContainerImage": "The container used to run the inference environment."
|
|
46122
|
+
}
|
|
46123
|
+
},
|
|
46124
|
+
"AWS::SageMaker::ModelCard.IntendedUses": {
|
|
46125
|
+
"attributes": {},
|
|
46126
|
+
"description": "The intended uses of a model.",
|
|
46127
|
+
"properties": {
|
|
46128
|
+
"ExplanationsForRiskRating": "An explanation of why your organization categorizes the model with its risk rating.",
|
|
46129
|
+
"FactorsAffectingModelEfficiency": "Factors affecting model efficacy.",
|
|
46130
|
+
"IntendedUses": "The intended use cases for the model.",
|
|
46131
|
+
"PurposeOfModel": "The general purpose of the model.",
|
|
46132
|
+
"RiskRating": "Your organization's risk rating. You can specify one the following values as the risk rating:\n\n- High\n- Medium\n- Low\n- Unknown"
|
|
46133
|
+
}
|
|
46134
|
+
},
|
|
46135
|
+
"AWS::SageMaker::ModelCard.MetricGroup": {
|
|
46136
|
+
"attributes": {},
|
|
46137
|
+
"description": "A group of metric data that you use to initialize a metric group object.",
|
|
46138
|
+
"properties": {
|
|
46139
|
+
"MetricData": "A list of metric objects. The `MetricDataItems` list can have one of the following values:\n\n- `bar_chart_metric`\n- `matrix_metric`\n- `simple_metric`\n- `linear_graph_metric`\n\nFor more information about the metric schema, see the definition section of the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .",
|
|
46140
|
+
"Name": "The metric group name."
|
|
46141
|
+
}
|
|
46142
|
+
},
|
|
46143
|
+
"AWS::SageMaker::ModelCard.ModelOverview": {
|
|
46144
|
+
"attributes": {},
|
|
46145
|
+
"description": "An overview about the model.",
|
|
46146
|
+
"properties": {
|
|
46147
|
+
"AlgorithmType": "The algorithm used to solve the problem.",
|
|
46148
|
+
"InferenceEnvironment": "An overview about model inference.",
|
|
46149
|
+
"ModelArtifact": "The location of the model artifact.",
|
|
46150
|
+
"ModelCreator": "The creator of the model.",
|
|
46151
|
+
"ModelDescription": "A description of the model.",
|
|
46152
|
+
"ModelId": "The SageMaker Model ARN or non- SageMaker Model ID.",
|
|
46153
|
+
"ModelName": "The name of the model.",
|
|
46154
|
+
"ModelOwner": "The owner of the model.",
|
|
46155
|
+
"ModelVersion": "The version of the model.",
|
|
46156
|
+
"ProblemType": "The problem being solved with the model."
|
|
46157
|
+
}
|
|
46158
|
+
},
|
|
46159
|
+
"AWS::SageMaker::ModelCard.ObjectiveFunction": {
|
|
46160
|
+
"attributes": {},
|
|
46161
|
+
"description": "The function that is optimized during model training.",
|
|
46162
|
+
"properties": {
|
|
46163
|
+
"Function": "A function object that details optimization direction, metric, and additional descriptions.",
|
|
46164
|
+
"Notes": "Notes about the object function, including other considerations for possible objective functions."
|
|
46165
|
+
}
|
|
46166
|
+
},
|
|
46167
|
+
"AWS::SageMaker::ModelCard.SecurityConfig": {
|
|
46168
|
+
"attributes": {},
|
|
46169
|
+
"description": "The security configuration used to protect model card data.",
|
|
46170
|
+
"properties": {
|
|
46171
|
+
"KmsKeyId": "A AWS Key Management Service [key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) used to encrypt a model card."
|
|
46172
|
+
}
|
|
46173
|
+
},
|
|
46174
|
+
"AWS::SageMaker::ModelCard.TrainingDetails": {
|
|
46175
|
+
"attributes": {},
|
|
46176
|
+
"description": "The training details of the model",
|
|
46177
|
+
"properties": {
|
|
46178
|
+
"ObjectiveFunction": "The function that is optimized during model training.",
|
|
46179
|
+
"TrainingJobDetails": "Details about any associated training jobs.",
|
|
46180
|
+
"TrainingObservations": "Any observations about training."
|
|
46181
|
+
}
|
|
46182
|
+
},
|
|
46183
|
+
"AWS::SageMaker::ModelCard.TrainingEnvironment": {
|
|
46184
|
+
"attributes": {},
|
|
46185
|
+
"description": "SageMaker training image.",
|
|
46186
|
+
"properties": {
|
|
46187
|
+
"ContainerImage": "SageMaker inference image URI."
|
|
46188
|
+
}
|
|
46189
|
+
},
|
|
46190
|
+
"AWS::SageMaker::ModelCard.TrainingHyperParameter": {
|
|
46191
|
+
"attributes": {},
|
|
46192
|
+
"description": "A hyper parameter that was configured in training the model.",
|
|
46193
|
+
"properties": {
|
|
46194
|
+
"Name": "The name of the hyper parameter.",
|
|
46195
|
+
"Value": "The value specified for the hyper parameter."
|
|
46196
|
+
}
|
|
46197
|
+
},
|
|
46198
|
+
"AWS::SageMaker::ModelCard.TrainingJobDetails": {
|
|
46199
|
+
"attributes": {},
|
|
46200
|
+
"description": "The overview of a training job.",
|
|
46201
|
+
"properties": {
|
|
46202
|
+
"HyperParameters": "The hyper parameters used in the training job.",
|
|
46203
|
+
"TrainingArn": "The SageMaker training job Amazon Resource Name (ARN)",
|
|
46204
|
+
"TrainingDatasets": "The location of the datasets used to train the model.",
|
|
46205
|
+
"TrainingEnvironment": "The SageMaker training job image URI.",
|
|
46206
|
+
"TrainingMetrics": "The SageMaker training job results.",
|
|
46207
|
+
"UserProvidedHyperParameters": "Additional hyper parameters that you've specified when training the model.",
|
|
46208
|
+
"UserProvidedTrainingMetrics": "Custom training job results."
|
|
46209
|
+
}
|
|
46210
|
+
},
|
|
46211
|
+
"AWS::SageMaker::ModelCard.TrainingMetric": {
|
|
46212
|
+
"attributes": {},
|
|
46213
|
+
"description": "A result from a SageMaker training job.",
|
|
46214
|
+
"properties": {
|
|
46215
|
+
"Name": "The name of the result from the SageMaker training job.",
|
|
46216
|
+
"Notes": "Any additional notes describing the result of the training job.",
|
|
46217
|
+
"Value": "The value of a result from the SageMaker training job."
|
|
46218
|
+
}
|
|
46219
|
+
},
|
|
45797
46220
|
"AWS::SageMaker::ModelExplainabilityJobDefinition": {
|
|
45798
46221
|
"attributes": {
|
|
45799
46222
|
"CreationTime": "The time when the job definition was created.",
|
|
@@ -47133,18 +47556,18 @@
|
|
|
47133
47556
|
"attributes": {
|
|
47134
47557
|
"Ref": "When you pass the logical ID of an `AWS::SecretsManager::RotationSchedule` resource to the intrinsic `Ref` function, the function returns the ARN of the secret being configured, such as:\n\n*arn:aws:secretsmanager: us-west-2* : *123456789012* :secret: *my-path/my-secret-name* - *1a2b3c*\n\nYou can use the ARN to reference a secret you create in one part of the stack template from within the definition of another resource later, in the same template. You typically do this when you define the [AWS::SecretsManager::SecretTargetAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html) resource type.\n\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
47135
47558
|
},
|
|
47136
|
-
"description": "Sets the rotation schedule and Lambda rotation function for a secret. For more information, see [How rotation works](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) .
|
|
47559
|
+
"description": "Sets the rotation schedule and Lambda rotation function for a secret. For more information, see [How rotation works](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) .\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .\n\nFor the rotation function, you have two options:\n\n- You can create a new rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) by using `HostedRotationLambda` .\n- You can choose an existing rotation function by using `RotationLambdaARN` .\n\nFor database secrets, if you define both the secret and the database or service in the AWS CloudFormation template, then you need to define the [AWS::SecretsManager::SecretTargetAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html) resource to populate the secret with the connection details of the database or service before you attempt to configure rotation.",
|
|
47137
47560
|
"properties": {
|
|
47138
|
-
"HostedRotationLambda": "Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead.",
|
|
47561
|
+
"HostedRotationLambda": "Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead.\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .",
|
|
47139
47562
|
"RotateImmediatelyOnUpdate": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in `RotationRules` .\n\nIf you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the [`testSecret` step](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an `AWSPENDING` version of the secret and then removes it.\n\nIf you don't specify this value, then by default, Secrets Manager rotates the secret immediately.\n\nRotation is an asynchronous process. For more information, see [How rotation works](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) .",
|
|
47140
|
-
"RotationLambdaARN": "The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function.\n\nTo create a new rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) , specify `HostedRotationLambda` instead.",
|
|
47563
|
+
"RotationLambdaARN": "The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function.\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .\n\nTo create a new rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) , specify `HostedRotationLambda` instead.",
|
|
47141
47564
|
"RotationRules": "A structure that defines the rotation configuration for this secret.",
|
|
47142
47565
|
"SecretId": "The ARN or name of the secret to rotate.\n\nTo reference a secret also created in this template, use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function with the secret's logical ID."
|
|
47143
47566
|
}
|
|
47144
47567
|
},
|
|
47145
47568
|
"AWS::SecretsManager::RotationSchedule.HostedRotationLambda": {
|
|
47146
47569
|
"attributes": {},
|
|
47147
|
-
"description": "Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .\n\nYou must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.",
|
|
47570
|
+
"description": "Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .\n\nYou must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .",
|
|
47148
47571
|
"properties": {
|
|
47149
47572
|
"ExcludeCharacters": "A string of the characters that you don't want in the password.",
|
|
47150
47573
|
"KmsKeyArn": "The ARN of the KMS key that Secrets Manager uses to encrypt the secret. If you don't specify this value, then Secrets Manager uses the key `aws/secretsmanager` . If `aws/secretsmanager` doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.",
|
|
@@ -47171,14 +47594,14 @@
|
|
|
47171
47594
|
"attributes": {
|
|
47172
47595
|
"Ref": "When you pass the logical ID of an `AWS::SecretsManager::Secret` resource to the intrinsic `Ref` function, the function returns the ARN of the secret configured such as:\n\n`arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c`\n\nIf you know the ARN of a secret, you can reference a secret you created in one part of the stack template from within the definition of another resource in the same template. You typically use the `Ref` function with the [AWS::SecretsManager::SecretTargetAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html) resource type to get references to both the secret and its associated database.\n\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
47173
47596
|
},
|
|
47174
|
-
"description": "Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.\n\nTo retrieve a secret in a CloudFormation template, use a *dynamic reference* . For more information, see [Retrieve a secret in an AWS CloudFormation resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html) .\n\nA common scenario is to first create a secret with `GenerateSecretString` , which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. Follow these steps, as shown in the examples below:\n\n- Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. The secret must contain a username and password.\n- Next, define the service or database. Include the reference to the secret to use stored credentials to define the database admin user and password.\n- Finally, define a `SecretTargetAttachment` resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a [AWS::SecretsManager::RotationSchedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html) resource type.\n\nFor information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) . For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html) .\n\nFor information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html) .\n\n> Do not create a dynamic reference using a backslash `(\\)` as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure.",
|
|
47597
|
+
"description": "Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .\n\nTo retrieve a secret in a CloudFormation template, use a *dynamic reference* . For more information, see [Retrieve a secret in an AWS CloudFormation resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html) .\n\nA common scenario is to first create a secret with `GenerateSecretString` , which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. Follow these steps, as shown in the examples below:\n\n- Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. The secret must contain a username and password.\n- Next, define the service or database. Include the reference to the secret to use stored credentials to define the database admin user and password.\n- Finally, define a `SecretTargetAttachment` resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a [AWS::SecretsManager::RotationSchedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html) resource type.\n\nFor information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) . For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html) .\n\nFor information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html) .\n\n> Do not create a dynamic reference using a backslash `(\\)` as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure.",
|
|
47175
47598
|
"properties": {
|
|
47176
47599
|
"Description": "The description of the secret.",
|
|
47177
|
-
"GenerateSecretString": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use `SecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret.\n\nWe recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.",
|
|
47600
|
+
"GenerateSecretString": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use `SecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret. When you make a change to this property, a new secret version is created.\n\nWe recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.",
|
|
47178
47601
|
"KmsKeyId": "The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by `alias/` , for example `alias/aws/secretsmanager` . For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html) .\n\nTo use a AWS KMS key in a different account, use the key ARN or the alias ARN.\n\nIf you don't specify this value, then Secrets Manager uses the key `aws/secretsmanager` . If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.\n\nIf the secret is in a different AWS account from the credentials calling the API, then you can't use `aws/secretsmanager` to encrypt the secret, and you must create and use a customer managed AWS KMS key.",
|
|
47179
47602
|
"Name": "The name of the new secret.\n\nThe secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-\n\nDo not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.",
|
|
47180
47603
|
"ReplicaRegions": "A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.",
|
|
47181
|
-
"SecretString": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use `GenerateSecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret.",
|
|
47604
|
+
"SecretString": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use `GenerateSecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret. When you make a change to this property, a new secret version is created.",
|
|
47182
47605
|
"Tags": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:\n\n`[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]`\n\nSecrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".\n\nIf you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an `Access Denied` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2) .\n\nFor information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.\n\nThe following restrictions apply to tags:\n\n- Maximum number of tags per secret: 50\n- Maximum key length: 127 Unicode characters in UTF-8\n- Maximum value length: 255 Unicode characters in UTF-8\n- Tag keys and values are case sensitive.\n- Do not use the `aws:` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.\n- If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @."
|
|
47183
47606
|
}
|
|
47184
47607
|
},
|
|
@@ -47210,7 +47633,7 @@
|
|
|
47210
47633
|
"attributes": {
|
|
47211
47634
|
"Ref": "When you pass the logical ID of an `AWS::SecretsManager::SecretTargetAttachment` resource to the intrinsic `Ref` function, the function returns the ARN of the secret, such as:\n\n`arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c`\n\nYou can use the ARN to reference a secret you created in one part of the stack template from within the definition of another resource from a different part of the same template.\n\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
47212
47635
|
},
|
|
47213
|
-
"description": "The `AWS::SecretsManager::SecretTargetAttachment` resource completes the final link between a Secrets Manager secret and the associated database by adding the database connection information to the secret JSON. If you want to turn on automatic rotation for a database credential secret, the secret must contain the database connection information. For more information, see [JSON structure of Secrets Manager database credential secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html) .",
|
|
47636
|
+
"description": "The `AWS::SecretsManager::SecretTargetAttachment` resource completes the final link between a Secrets Manager secret and the associated database by adding the database connection information to the secret JSON. If you want to turn on automatic rotation for a database credential secret, the secret must contain the database connection information. For more information, see [JSON structure of Secrets Manager database credential secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html) .\n\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) .",
|
|
47214
47637
|
"properties": {
|
|
47215
47638
|
"SecretId": "The ARN or name of the secret. To reference a secret also created in this template, use the see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function with the secret's logical ID.",
|
|
47216
47639
|
"TargetId": "The ID of the database or cluster.",
|
|
@@ -47264,7 +47687,7 @@
|
|
|
47264
47687
|
"properties": {
|
|
47265
47688
|
"Description": "The description of the provisioning artifact, including how it differs from the previous provisioning artifact.",
|
|
47266
47689
|
"DisableTemplateValidation": "If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.",
|
|
47267
|
-
"Info": "Specify the template source with one of the following options, but not both. Keys accepted: [ `LoadTemplateFromURL` , `ImportFromPhysicalId` ]\n\nThe URL of the AWS CloudFormation template in Amazon S3
|
|
47690
|
+
"Info": "Specify the template source with one of the following options, but not both. Keys accepted: [ `LoadTemplateFromURL` , `ImportFromPhysicalId` ]\n\nThe URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:\n\n`\"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"`\n\n`ImportFromPhysicalId` : The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: `ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]`",
|
|
47268
47691
|
"Name": "The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed."
|
|
47269
47692
|
}
|
|
47270
47693
|
},
|
|
@@ -47283,7 +47706,7 @@
|
|
|
47283
47706
|
"PathId": "The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .\n\n> You must provide the name or ID, but not both.",
|
|
47284
47707
|
"PathName": "The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .\n\n> You must provide the name or ID, but not both.",
|
|
47285
47708
|
"ProductId": "The product identifier.\n\n> You must specify either the ID or the name of the product, but not both.",
|
|
47286
|
-
"ProductName": "
|
|
47709
|
+
"ProductName": "The name of the Service Catalog product.\n\nEach time a stack is created or updated, if `ProductName` is provided it will successfully resolve to `ProductId` as long as only one product exists in the account or Region with that `ProductName` .\n\n> You must specify either the name or the ID of the product, but not both.",
|
|
47287
47710
|
"ProvisionedProductName": "A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.",
|
|
47288
47711
|
"ProvisioningArtifactId": "The identifier of the provisioning artifact (also known as a version).\n\n> You must specify either the ID or the name of the provisioning artifact, but not both.",
|
|
47289
47712
|
"ProvisioningArtifactName": "The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.\n\n> You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.",
|
|
@@ -47371,12 +47794,12 @@
|
|
|
47371
47794
|
"attributes": {
|
|
47372
47795
|
"Ref": "`Ref` returns a unique identifier for the association."
|
|
47373
47796
|
},
|
|
47374
|
-
"description": "Associates the specified principal ARN with the specified portfolio.",
|
|
47797
|
+
"description": "Associates the specified principal ARN with the specified portfolio.\n\nIf you share the portfolio with principal name sharing enabled, the `PrincipalARN` association is included in the share.\n\nThe `PortfolioID` , `PrincipalARN` , and `PrincipalType` parameters are required.\n\nYou can associate a maximum of 10 Principals with a portfolio using `PrincipalType` as `IAM_PATTERN`\n\n> When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is *not* an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using `PrincipalType` as `IAM` . With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated.",
|
|
47375
47798
|
"properties": {
|
|
47376
47799
|
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
|
|
47377
47800
|
"PortfolioId": "The portfolio identifier.",
|
|
47378
|
-
"PrincipalARN": "The ARN of the principal (IAM user, role, or group).",
|
|
47379
|
-
"PrincipalType": "The principal type. The supported value is `IAM` ."
|
|
47801
|
+
"PrincipalARN": "The ARN of the principal (IAM user, role, or group). This field allows an ARN with no `accountID` if `PrincipalType` is `IAM_PATTERN` .\n\nYou can associate multiple `IAM` patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio.",
|
|
47802
|
+
"PrincipalType": "The principal type. The supported value is `IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you use an ARN with no `accountID` ."
|
|
47380
47803
|
}
|
|
47381
47804
|
},
|
|
47382
47805
|
"AWS::ServiceCatalog::PortfolioProductAssociation": {
|
|
@@ -47718,6 +48141,26 @@
|
|
|
47718
48141
|
"Value": "The numerical value of the time unit for signature validity."
|
|
47719
48142
|
}
|
|
47720
48143
|
},
|
|
48144
|
+
"AWS::SimSpaceWeaver::Simulation": {
|
|
48145
|
+
"attributes": {
|
|
48146
|
+
"DescribePayload": "The JSON blob that the [DescribeSimulation](https://docs.aws.amazon.com/simspaceweaver/latest/APIReference/API_DescribeSimulation.html) action returns.",
|
|
48147
|
+
"Ref": "`Ref` returns the name of the `Simulation` . For example, `MyTestSimulation_22-12-15_12_00_00` ."
|
|
48148
|
+
},
|
|
48149
|
+
"description": "Use the `AWS::SimSpaceWeaver::Simulation` resource to specify a simulation that AWS CloudFormation starts in the AWS Cloud , in your AWS account . In the resource properties section of your template, provide the name of an existing IAM role configured with the proper permissions, and the name of an existing Amazon S3 bucket. Your account must have permissions to read the Amazon S3 bucket. The Amazon S3 bucket must contain a valid schema. The schema must refer to simulation assets that are already uploaded to the AWS Cloud . For more information, see the [detailed tutorial](https://docs.aws.amazon.com/simspaceweaver/latest/userguide/getting-started_detailed.html) in the *AWS SimSpace Weaver User Guide* .",
|
|
48150
|
+
"properties": {
|
|
48151
|
+
"Name": "The name of the simulation.",
|
|
48152
|
+
"RoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference* . For more information about IAM roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management User Guide* .",
|
|
48153
|
+
"SchemaS3Location": "The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ). For more information about Amazon S3 , see the [*Amazon Simple Storage Service User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) ."
|
|
48154
|
+
}
|
|
48155
|
+
},
|
|
48156
|
+
"AWS::SimSpaceWeaver::Simulation.S3Location": {
|
|
48157
|
+
"attributes": {},
|
|
48158
|
+
"description": "A location in Amazon Simple Storage Service ( Amazon S3 ) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3 , see the [*Amazon Simple Storage Service User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) .",
|
|
48159
|
+
"properties": {
|
|
48160
|
+
"BucketName": "The name of an Amazon S3 bucket. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the *Amazon Simple Storage Service User Guide* .",
|
|
48161
|
+
"ObjectKey": "The key name of an object in Amazon S3 . For more information about Amazon S3 objects and object keys, see [Uploading, downloading, and working with objects in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) in the *Amazon Simple Storage Service User Guide* ."
|
|
48162
|
+
}
|
|
48163
|
+
},
|
|
47721
48164
|
"AWS::StepFunctions::Activity": {
|
|
47722
48165
|
"attributes": {
|
|
47723
48166
|
"Arn": "",
|
|
@@ -48294,7 +48737,7 @@
|
|
|
48294
48737
|
"Arn": "The Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: *account-id* :user/ *server-id* / *username*` .\n\nAn example of a user ARN is: `arn:aws:transfer:us-east-1:123456789012:user/user1` .",
|
|
48295
48738
|
"Ref": "`Ref` returns the username, such as `transfer_user` .",
|
|
48296
48739
|
"ServerId": "The ID of the server to which the user is attached.\n\nAn example `ServerId` is `s-01234567890abcdef` .",
|
|
48297
|
-
"UserName": "A unique string that identifies a user account associated with a server.\n\nAn example `UserName` is `transfer-user-1` ."
|
|
48740
|
+
"UserName": "A unique string that identifies a Transfer Family user account associated with a server.\n\nAn example `UserName` is `transfer-user-1` ."
|
|
48298
48741
|
},
|
|
48299
48742
|
"description": "The `AWS::Transfer::User` resource creates a user and associates them with an existing server. You can only create and associate users with servers that have the `IdentityProviderType` set to `SERVICE_MANAGED` . Using parameters for `CreateUser` , you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.",
|
|
48300
48743
|
"properties": {
|
|
@@ -48329,7 +48772,7 @@
|
|
|
48329
48772
|
},
|
|
48330
48773
|
"AWS::Transfer::User.SshPublicKey": {
|
|
48331
48774
|
"attributes": {},
|
|
48332
|
-
"description": "Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by `ServerId` ). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.\n\n*SshPublicKeyBody*\n\nSpecifies the content of the SSH public key as specified by the `PublicKeyId` .\n\nAWS Transfer Family accepts RSA, ECDSA, and ED25519 keys.\n\nType: String\n\nLength Constraints: Maximum length of 2048.\n\nRequired: Yes",
|
|
48775
|
+
"description": "Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user account for the specific file transfer protocol-enabled server (as identified by `ServerId` ). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.\n\n*SshPublicKeyBody*\n\nSpecifies the content of the SSH public key as specified by the `PublicKeyId` .\n\nAWS Transfer Family accepts RSA, ECDSA, and ED25519 keys.\n\nType: String\n\nLength Constraints: Maximum length of 2048.\n\nRequired: Yes",
|
|
48333
48776
|
"properties": {}
|
|
48334
48777
|
},
|
|
48335
48778
|
"AWS::Transfer::Workflow": {
|
|
@@ -49265,7 +49708,7 @@
|
|
|
49265
49708
|
},
|
|
49266
49709
|
"AWS::WAFv2::RuleGroup.RateBasedStatement": {
|
|
49267
49710
|
"attributes": {},
|
|
49268
|
-
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that
|
|
49711
|
+
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specifies the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
49269
49712
|
"properties": {
|
|
49270
49713
|
"AggregateKeyType": "Setting that indicates how to aggregate the request counts. The options are the following:\n\n- IP - Aggregate the request counts on the IP address from the web request origin.\n- FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the `ForwardedIPConfig` , to specify the header to use.",
|
|
49271
49714
|
"ForwardedIPConfig": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n\n> If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. \n\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP` .",
|
|
@@ -49360,7 +49803,7 @@
|
|
|
49360
49803
|
"LabelMatchStatement": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.\n\nThe label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.",
|
|
49361
49804
|
"NotStatement": "A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .",
|
|
49362
49805
|
"OrStatement": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .",
|
|
49363
|
-
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that
|
|
49806
|
+
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specifies the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
49364
49807
|
"RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression.",
|
|
49365
49808
|
"RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions. To use this, create a `RegexPatternSet` that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set.\n\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
49366
49809
|
"SizeConstraintStatement": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.\n\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.",
|
|
@@ -49724,7 +50167,7 @@
|
|
|
49724
50167
|
},
|
|
49725
50168
|
"AWS::WAFv2::WebACL.RateBasedStatement": {
|
|
49726
50169
|
"attributes": {},
|
|
49727
|
-
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that
|
|
50170
|
+
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specifies the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
49728
50171
|
"properties": {
|
|
49729
50172
|
"AggregateKeyType": "Setting that indicates how to aggregate the request counts. The options are the following:\n\n- IP - Aggregate the request counts on the IP address from the web request origin.\n- FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the `ForwardedIPConfig` , to specify the header to use.",
|
|
49730
50173
|
"ForwardedIPConfig": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n\n> If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. \n\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP` .",
|
|
@@ -49838,7 +50281,7 @@
|
|
|
49838
50281
|
"ManagedRuleGroupStatement": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement.\n\nYou cannot nest a `ManagedRuleGroupStatement` , for example for use inside a `NotStatement` or `OrStatement` . It can only be referenced as a top-level statement within a rule.",
|
|
49839
50282
|
"NotStatement": "A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .",
|
|
49840
50283
|
"OrStatement": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .",
|
|
49841
|
-
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that
|
|
50284
|
+
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specifies the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
49842
50285
|
"RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression.",
|
|
49843
50286
|
"RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions. To use this, create a `RegexPatternSet` that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set.\n\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
49844
50287
|
"RuleGroupReferenceStatement": "A rule statement used to run the rules that are defined in a `RuleGroup` . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.\n\nYou cannot nest a `RuleGroupReferenceStatement` , for example for use inside a `NotStatement` or `OrStatement` . You can only use a rule group reference statement at the top level inside a web ACL.",
|