cdk-common 2.0.50 → 2.0.54
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/changelog.md +1 -1
- package/lib/main.js +1 -1
- package/node_modules/@aws-cdk/assert/README.md +6 -7
- package/node_modules/@aws-cdk/assert/package.json +11 -11
- package/node_modules/@aws-cdk/cfnspec/CHANGELOG.md +284 -0
- package/node_modules/@aws-cdk/cfnspec/build-tools/create-missing-libraries.js +5 -3
- package/node_modules/@aws-cdk/cfnspec/build-tools/update.sh +8 -4
- package/node_modules/@aws-cdk/cfnspec/cfn.version +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/massage-spec.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/patch-set.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/scrutiny.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/validate-cfn.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/junit.xml +6634 -5928
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/massage-spec.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/patch-set.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/scrutiny.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/validate-cfn.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics/canned-metrics-schema.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics.ts.html +23 -23
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/index.ts.html +18 -18
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/augmentation.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/base-types.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/index.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/property.ts.html +13 -13
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/resource-type.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/specification.ts.html +2 -2
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov.info +117 -117
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics/canned-metrics-schema.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics.ts.html +23 -23
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.ts.html +18 -18
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/augmentation.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/base-types.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/index.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/property.ts.html +13 -13
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/resource-type.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/specification.ts.html +2 -2
- package/node_modules/@aws-cdk/cfnspec/package.json +3 -3
- package/node_modules/@aws-cdk/cfnspec/spec/cfn-docs.json +475 -202
- package/node_modules/@aws-cdk/cfnspec/spec/specification.json +2467 -83
- package/node_modules/@aws-cdk/cfnspec/tsconfig.tsbuildinfo +16 -16
- package/node_modules/@aws-cdk/cloudformation-diff/package.json +5 -5
- package/node_modules/@types/concat-stream/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/concat-stream/node_modules/@types/node/crypto.d.ts +1 -1
- package/node_modules/@types/concat-stream/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/form-data/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/form-data/node_modules/@types/node/crypto.d.ts +1 -1
- package/node_modules/@types/form-data/node_modules/@types/node/package.json +2 -2
- package/package.json +2 -2
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -512,7 +512,7 @@
|
|
|
512
512
|
"properties": {
|
|
513
513
|
"AccessToken": "Personal Access token for 3rd party source control system for an Amplify app, used to create webhook and read-only deploy key. Token is not stored.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 255.",
|
|
514
514
|
"AutoBranchCreationConfig": "Sets the configuration for your automatic branch creation.",
|
|
515
|
-
"BasicAuthConfig": "The credentials for basic authorization for an Amplify app.",
|
|
515
|
+
"BasicAuthConfig": "The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .",
|
|
516
516
|
"BuildSpec": "The build specification (build spec) for an Amplify app.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+",
|
|
517
517
|
"CustomHeaders": "The custom HTTP headers for an Amplify app.\n\n*Length Constraints:* Minimum length of 0. Maximum length of 25000.\n\n*Pattern:* (?s).*",
|
|
518
518
|
"CustomRules": "The custom rewrite and redirect rules for an Amplify app.",
|
|
@@ -577,7 +577,7 @@
|
|
|
577
577
|
"description": "The AWS::Amplify::Branch resource creates a new branch within an app.",
|
|
578
578
|
"properties": {
|
|
579
579
|
"AppId": "The unique ID for an Amplify app.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 20.\n\n*Pattern:* d[a-z0-9]+",
|
|
580
|
-
"BasicAuthConfig": "The basic authorization credentials for a branch of an Amplify app.",
|
|
580
|
+
"BasicAuthConfig": "The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .",
|
|
581
581
|
"BranchName": "The name for the branch.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+",
|
|
582
582
|
"BuildSpec": "The build specification (build spec) for the branch.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+",
|
|
583
583
|
"Description": "The description for the branch that is part of an Amplify app.\n\n*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*",
|
|
@@ -647,13 +647,13 @@
|
|
|
647
647
|
},
|
|
648
648
|
"description": "The AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app. A component is a user interface (UI) element that you can customize. Use `ComponentChild` to configure an instance of a `Component` . A `ComponentChild` instance inherits the configuration of the main `Component` .",
|
|
649
649
|
"properties": {
|
|
650
|
-
"BindingProperties": "The information to connect a component's properties to data at runtime.",
|
|
650
|
+
"BindingProperties": "The information to connect a component's properties to data at runtime. You can't specify `tags` as a valid property for `bindingProperties` .",
|
|
651
651
|
"Children": "A list of the component's `ComponentChild` instances.",
|
|
652
|
-
"CollectionProperties": "The data binding configuration for the component's properties. Use this for a collection component.",
|
|
652
|
+
"CollectionProperties": "The data binding configuration for the component's properties. Use this for a collection component. You can't specify `tags` as a valid property for `collectionProperties` .",
|
|
653
653
|
"ComponentType": "The type of the component. This can be an Amplify custom UI component or another custom component.",
|
|
654
654
|
"Name": "The name of the component.",
|
|
655
|
-
"Overrides": "Describes the component's properties that can be overriden in a customized instance of the component.",
|
|
656
|
-
"Properties": "Describes the component's properties.",
|
|
655
|
+
"Overrides": "Describes the component's properties that can be overriden in a customized instance of the component. You can't specify `tags` as a valid property for `overrides` .",
|
|
656
|
+
"Properties": "Describes the component's properties. You can't specify `tags` as a valid property for `properties` .",
|
|
657
657
|
"SourceId": "The unique ID of the component in its original source system, such as Figma.",
|
|
658
658
|
"Tags": "One or more key-value pairs to use when tagging the component.",
|
|
659
659
|
"Variants": "A list of the component's variants. A variant is a unique style configuration of a main component."
|
|
@@ -688,7 +688,7 @@
|
|
|
688
688
|
"Children": "The list of `ComponentChild` instances for this component.",
|
|
689
689
|
"ComponentType": "The type of the child component.",
|
|
690
690
|
"Name": "The name of the child component.",
|
|
691
|
-
"Properties": "Describes the properties of the child component."
|
|
691
|
+
"Properties": "Describes the properties of the child component. You can't specify `tags` as a valid property for `properties` ."
|
|
692
692
|
}
|
|
693
693
|
},
|
|
694
694
|
"AWS::AmplifyUIBuilder::Component.ComponentConditionProperty": {
|
|
@@ -759,7 +759,7 @@
|
|
|
759
759
|
"attributes": {},
|
|
760
760
|
"description": "The `ComponentVariant` property specifies the style configuration of a unique variation of a main component.",
|
|
761
761
|
"properties": {
|
|
762
|
-
"Overrides": "The properties of the component variant that can be overriden when customizing an instance of the component.",
|
|
762
|
+
"Overrides": "The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify `tags` as a valid property for `overrides` .",
|
|
763
763
|
"VariantValues": "The combination of variants that comprise this variant."
|
|
764
764
|
}
|
|
765
765
|
},
|
|
@@ -827,7 +827,7 @@
|
|
|
827
827
|
},
|
|
828
828
|
"AWS::ApiGateway::Account": {
|
|
829
829
|
"attributes": {
|
|
830
|
-
"Id": "",
|
|
830
|
+
"Id": "The ID for the account. For example: `abc123` .",
|
|
831
831
|
"Ref": "`Ref` returns the ID of the resource, such as `mysta-accou-01234b567890example` ."
|
|
832
832
|
},
|
|
833
833
|
"description": "The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs.\n\n> If an API Gateway resource has never been created in your AWS account , you must add a dependency on another API Gateway resource, such as an [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) or [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource.\n> \n> If an API Gateway resource has been created in your AWS account , no dependency is required (even if the resource was deleted).",
|
|
@@ -862,7 +862,7 @@
|
|
|
862
862
|
},
|
|
863
863
|
"AWS::ApiGateway::Authorizer": {
|
|
864
864
|
"attributes": {
|
|
865
|
-
"AuthorizerId": "",
|
|
865
|
+
"AuthorizerId": "The ID for the authorizer. For example: `abc123` .",
|
|
866
866
|
"Ref": "`Ref` returns the authorizer's ID, such as `abcde1` ."
|
|
867
867
|
},
|
|
868
868
|
"description": "The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.",
|
|
@@ -902,7 +902,7 @@
|
|
|
902
902
|
},
|
|
903
903
|
"AWS::ApiGateway::Deployment": {
|
|
904
904
|
"attributes": {
|
|
905
|
-
"DeploymentId": "",
|
|
905
|
+
"DeploymentId": "The ID for the deployment. For example: `abc123` .",
|
|
906
906
|
"Ref": "`Ref` returns the deployment ID, such as `123abc` ."
|
|
907
907
|
},
|
|
908
908
|
"description": "The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.",
|
|
@@ -976,7 +976,7 @@
|
|
|
976
976
|
"MetricsEnabled": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.",
|
|
977
977
|
"Tags": "An array of arbitrary tags (key-value pairs) to associate with the stage.",
|
|
978
978
|
"ThrottlingBurstLimit": "The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .",
|
|
979
|
-
"ThrottlingRateLimit": "The
|
|
979
|
+
"ThrottlingRateLimit": "The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .",
|
|
980
980
|
"TracingEnabled": "Specifies whether active tracing with X-ray is enabled for this stage.\n\nFor more information, see [Trace API Gateway API Execution with AWS X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide* .",
|
|
981
981
|
"Variables": "A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` ."
|
|
982
982
|
}
|
|
@@ -1049,7 +1049,7 @@
|
|
|
1049
1049
|
},
|
|
1050
1050
|
"AWS::ApiGateway::GatewayResponse": {
|
|
1051
1051
|
"attributes": {
|
|
1052
|
-
"Id": ""
|
|
1052
|
+
"Id": "The ID for the gateway response. For example: `abc123` ."
|
|
1053
1053
|
},
|
|
1054
1054
|
"description": "The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide* .",
|
|
1055
1055
|
"properties": {
|
|
@@ -1150,7 +1150,7 @@
|
|
|
1150
1150
|
"AWS::ApiGateway::Resource": {
|
|
1151
1151
|
"attributes": {
|
|
1152
1152
|
"Ref": "`Ref` returns the resource ID, such as `abc123` .",
|
|
1153
|
-
"ResourceId": ""
|
|
1153
|
+
"ResourceId": "The ID for the resource. For example: `abc123` ."
|
|
1154
1154
|
},
|
|
1155
1155
|
"description": "The `AWS::ApiGateway::Resource` resource creates a resource in an API.",
|
|
1156
1156
|
"properties": {
|
|
@@ -1259,7 +1259,7 @@
|
|
|
1259
1259
|
},
|
|
1260
1260
|
"AWS::ApiGateway::UsagePlan": {
|
|
1261
1261
|
"attributes": {
|
|
1262
|
-
"Id": "",
|
|
1262
|
+
"Id": "The ID for the usage plan. For example: `abc123` .",
|
|
1263
1263
|
"Ref": "`Ref` returns the usage plan ID, such as `abc123` ."
|
|
1264
1264
|
},
|
|
1265
1265
|
"description": "The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide* .\n\nIn some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.",
|
|
@@ -1318,7 +1318,7 @@
|
|
|
1318
1318
|
"properties": {
|
|
1319
1319
|
"Description": "A description of the VPC link.",
|
|
1320
1320
|
"Name": "A name for the VPC link.",
|
|
1321
|
-
"Tags": "",
|
|
1321
|
+
"Tags": "An array of arbitrary tags (key-value pairs) to associate with the VPC link.",
|
|
1322
1322
|
"TargetArns": "The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner."
|
|
1323
1323
|
}
|
|
1324
1324
|
},
|
|
@@ -1721,7 +1721,7 @@
|
|
|
1721
1721
|
"Name": "A name for the configuration profile.",
|
|
1722
1722
|
"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.",
|
|
1723
1723
|
"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.",
|
|
1724
|
-
"Type": "The type of configurations
|
|
1724
|
+
"Type": "The type of configurations contained in the profile. AWS AppConfig supports `feature flags` and `freeform` configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for `Type` :\n\n`AWS.AppConfig.FeatureFlags`\n\n`AWS.Freeform`",
|
|
1725
1725
|
"Validators": "A list of methods for validating the configuration."
|
|
1726
1726
|
}
|
|
1727
1727
|
},
|
|
@@ -1735,7 +1735,7 @@
|
|
|
1735
1735
|
},
|
|
1736
1736
|
"AWS::AppConfig::ConfigurationProfile.Validators": {
|
|
1737
1737
|
"attributes": {},
|
|
1738
|
-
"description": "A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or
|
|
1738
|
+
"description": "A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an AWS Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.",
|
|
1739
1739
|
"properties": {
|
|
1740
1740
|
"Content": "Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.",
|
|
1741
1741
|
"Type": "AWS AppConfig supports validators of type `JSON_SCHEMA` and `LAMBDA`"
|
|
@@ -1821,7 +1821,7 @@
|
|
|
1821
1821
|
"attributes": {
|
|
1822
1822
|
"Ref": "`Ref` returns the version number."
|
|
1823
1823
|
},
|
|
1824
|
-
"description": "Create a new configuration in the AWS AppConfig hosted configuration store. Configurations must be
|
|
1824
|
+
"description": "Create a new configuration in the AWS AppConfig hosted configuration store. Configurations must be 1 MB or smaller. The AWS AppConfig hosted configuration store provides the following benefits over other configuration store options.\n\n- You don't need to set up and configure other services such as Amazon Simple Storage Service ( Amazon S3 ) or Parameter Store.\n- You don't need to configure AWS Identity and Access Management ( IAM ) permissions to use the configuration store.\n- You can store configurations in any content type.\n- There is no cost to use the store.\n- You can create a configuration and add it to the store when you create a configuration profile.",
|
|
1825
1825
|
"properties": {
|
|
1826
1826
|
"ApplicationId": "The application ID.",
|
|
1827
1827
|
"ConfigurationProfileId": "The configuration profile ID.",
|
|
@@ -4339,6 +4339,7 @@
|
|
|
4339
4339
|
"DataSourceName": "The name of data source this function will attach.",
|
|
4340
4340
|
"Description": "The `Function` description.",
|
|
4341
4341
|
"FunctionVersion": "The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.",
|
|
4342
|
+
"MaxBatchSize": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.",
|
|
4342
4343
|
"Name": "The name of the function.",
|
|
4343
4344
|
"RequestMappingTemplate": "The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.",
|
|
4344
4345
|
"RequestMappingTemplateS3Location": "Describes a Sync configuration for a resolver.\n\nContains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.",
|
|
@@ -4475,6 +4476,7 @@
|
|
|
4475
4476
|
"DataSourceName": "The resolver data source name.",
|
|
4476
4477
|
"FieldName": "The GraphQL field on a type that invokes the resolver.",
|
|
4477
4478
|
"Kind": "The resolver type.\n\n- *UNIT* : A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n- *PIPELINE* : A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.",
|
|
4479
|
+
"MaxBatchSize": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.",
|
|
4478
4480
|
"PipelineConfig": "Functions linked with the pipeline resolver.",
|
|
4479
4481
|
"RequestMappingTemplate": "The request mapping template.\n\nRequest mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.",
|
|
4480
4482
|
"RequestMappingTemplateS3Location": "The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.",
|
|
@@ -4694,6 +4696,8 @@
|
|
|
4694
4696
|
"properties": {
|
|
4695
4697
|
"AlarmMetrics": "A list of metrics to monitor for the component. All component types can use `AlarmMetrics` .",
|
|
4696
4698
|
"Alarms": "A list of alarms to monitor for the component. All component types can use `Alarm` .",
|
|
4699
|
+
"HAClusterPrometheusExporter": "",
|
|
4700
|
+
"HANAPrometheusExporter": "",
|
|
4697
4701
|
"JMXPrometheusExporter": "A list of Java metrics to monitor for the component.",
|
|
4698
4702
|
"Logs": "A list of logs to monitor for the component. Only Amazon EC2 instances can use `Logs` .",
|
|
4699
4703
|
"WindowsEvents": "A list of Windows Events to monitor for the component. Only Amazon EC2 instances running on Windows can use `WindowsEvents` ."
|
|
@@ -4707,6 +4711,24 @@
|
|
|
4707
4711
|
"ResourceList": "The list of resource ARNs that belong to the component."
|
|
4708
4712
|
}
|
|
4709
4713
|
},
|
|
4714
|
+
"AWS::ApplicationInsights::Application.HAClusterPrometheusExporter": {
|
|
4715
|
+
"attributes": {},
|
|
4716
|
+
"description": "",
|
|
4717
|
+
"properties": {
|
|
4718
|
+
"PrometheusPort": ""
|
|
4719
|
+
}
|
|
4720
|
+
},
|
|
4721
|
+
"AWS::ApplicationInsights::Application.HANAPrometheusExporter": {
|
|
4722
|
+
"attributes": {},
|
|
4723
|
+
"description": "",
|
|
4724
|
+
"properties": {
|
|
4725
|
+
"AgreeToInstallHANADBClient": "",
|
|
4726
|
+
"HANAPort": "",
|
|
4727
|
+
"HANASID": "",
|
|
4728
|
+
"HANASecretName": "",
|
|
4729
|
+
"PrometheusPort": ""
|
|
4730
|
+
}
|
|
4731
|
+
},
|
|
4710
4732
|
"AWS::ApplicationInsights::Application.JMXPrometheusExporter": {
|
|
4711
4733
|
"attributes": {},
|
|
4712
4734
|
"description": "The `AWS::ApplicationInsights::Application JMXPrometheusExporter` property type defines the JMXPrometheus Exporter configuration. For more information, see the [component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights documentation.",
|
|
@@ -4978,7 +5000,7 @@
|
|
|
4978
5000
|
"Cooldown": "The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is `300` . This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
4979
5001
|
"DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n\nThe number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n\nCloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.",
|
|
4980
5002
|
"DesiredCapacityType": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports `DesiredCapacityType` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nBy default, Amazon EC2 Auto Scaling specifies `units` , which translates into number of instances.\n\nValid values: `units` | `vcpu` | `memory-mib`",
|
|
4981
|
-
"HealthCheckGracePeriod": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is `0` . For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you are adding an `ELB` health check, you must specify this property.",
|
|
5003
|
+
"HealthCheckGracePeriod": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. The default value is `0` . For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you are adding an `ELB` health check, you must specify this property.",
|
|
4982
5004
|
"HealthCheckType": "The service to use for the health checks. The valid values are `EC2` (default) and `ELB` . If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
4983
5005
|
"InstanceId": "The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. For more information, see [Creating an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nTo get the instance ID, use the EC2 [DescribeInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) API operation.\n\nIf you specify `LaunchTemplate` , `MixedInstancesPolicy` , or `LaunchConfigurationName` , don't specify `InstanceId` .",
|
|
4984
5006
|
"LaunchConfigurationName": "The name of the [launch configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html) to use to launch instances.\n\nIf you specify `LaunchTemplate` , `MixedInstancesPolicy` , or `InstanceId` , don't specify `LaunchConfigurationName` .",
|
|
@@ -5239,7 +5261,7 @@
|
|
|
5239
5261
|
"attributes": {
|
|
5240
5262
|
"Ref": "When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: `mylifecyclehook` .\n\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
5241
5263
|
},
|
|
5242
|
-
"description": "The `AWS::AutoScaling::LifecycleHook` resource specifies lifecycle hooks for an Auto Scaling group. These hooks
|
|
5264
|
+
"description": "The `AWS::AutoScaling::LifecycleHook` resource specifies lifecycle hooks for an Auto Scaling group. These hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. A lifecycle hook provides a specified amount of time (one hour by default) to wait for the action to complete before the instance transitions to the next state.\n\nUse lifecycle hooks to prepare new instances for use or to delay them from being registered behind a load balancer before their configuration has been applied completely. You can also use lifecycle hooks to prepare running instances to be terminated by, for example, downloading logs or other data.\n\nFor more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide* and [PutLifecycleHook](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PutLifecycleHook.html) in the *Amazon EC2 Auto Scaling API Reference* .",
|
|
5243
5265
|
"properties": {
|
|
5244
5266
|
"AutoScalingGroupName": "The name of the Auto Scaling group for the lifecycle hook.",
|
|
5245
5267
|
"DefaultResult": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are `CONTINUE` and `ABANDON` (default).\n\nFor more information, see [Adding lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/adding-lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
@@ -5382,11 +5404,19 @@
|
|
|
5382
5404
|
"description": "The `AWS::AutoScaling::WarmPool` resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.\n\nWhen you create a warm pool, you can define a minimum size. When your Auto Scaling group scales out and the size of the warm pool shrinks, Amazon EC2 Auto Scaling launches new instances into the warm pool to maintain its minimum size.\n\nFor more information, see [Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\n> CloudFormation supports the `UpdatePolicy` attribute for Auto Scaling groups. During an update, if `UpdatePolicy` is set to `AutoScalingRollingUpdate` , CloudFormation replaces `InService` instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If `UpdatePolicy` is set to `AutoScalingReplacingUpdate` , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.",
|
|
5383
5405
|
"properties": {
|
|
5384
5406
|
"AutoScalingGroupName": "The name of the Auto Scaling group.",
|
|
5407
|
+
"InstanceReusePolicy": "",
|
|
5385
5408
|
"MaxGroupPreparedCapacity": "Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except `Terminated` for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.\n\n> If a value for `MaxGroupPreparedCapacity` is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for `MaxGroupPreparedCapacity` , Amazon EC2 Auto Scaling uses the difference between the `MaxGroupPreparedCapacity` and the desired capacity instead.\n> \n> The size of the warm pool is dynamic. Only when `MaxGroupPreparedCapacity` and `MinSize` are set to the same value does the warm pool have an absolute size. \n\nIf the desired capacity of the Auto Scaling group is higher than the `MaxGroupPreparedCapacity` , the capacity of the warm pool is 0, unless you specify a value for `MinSize` . To remove a value that you previously set, include the property but specify -1 for the value.",
|
|
5386
5409
|
"MinSize": "Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.",
|
|
5387
5410
|
"PoolState": "Sets the instance state to transition to after the lifecycle actions are complete. Default is `Stopped` ."
|
|
5388
5411
|
}
|
|
5389
5412
|
},
|
|
5413
|
+
"AWS::AutoScaling::WarmPool.InstanceReusePolicy": {
|
|
5414
|
+
"attributes": {},
|
|
5415
|
+
"description": "",
|
|
5416
|
+
"properties": {
|
|
5417
|
+
"ReuseOnScaleIn": ""
|
|
5418
|
+
}
|
|
5419
|
+
},
|
|
5390
5420
|
"AWS::AutoScalingPlans::ScalingPlan": {
|
|
5391
5421
|
"attributes": {
|
|
5392
5422
|
"Ref": "When you pass the logical ID of an `AWS::AutoScalingPlans::ScalingPlan` resource to the intrinsic `Ref` function, the function returns the Amazon Resource Name (ARN) of the scaling plan. The format of the ARN is as follows:\n\n`arn:aws:autoscaling: *region* : *123456789012:* scalingPlan:scalingPlanName/ *plan-name* :scalingPlanVersion/ *plan-version*`\n\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
@@ -5867,7 +5897,7 @@
|
|
|
5867
5897
|
},
|
|
5868
5898
|
"description": "The `AWS::CE::CostCategory` resource creates groupings of cost that you can use across products in the AWS Billing and Cost Management console, such as Cost Explorer and AWS Budgets. For more information, see [Managing Your Costs with Cost Categories](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html) in the *AWS Billing and Cost Management User Guide* .",
|
|
5869
5899
|
"properties": {
|
|
5870
|
-
"DefaultValue": "",
|
|
5900
|
+
"DefaultValue": "The default value for the cost category.",
|
|
5871
5901
|
"Name": "The unique name of the Cost Category.",
|
|
5872
5902
|
"RuleVersion": "The rule schema version in this particular Cost Category.",
|
|
5873
5903
|
"Rules": "The array of CostCategoryRule in JSON array format.\n\n> Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.",
|
|
@@ -7024,7 +7054,7 @@
|
|
|
7024
7054
|
"description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.\n\nYou can configure up to five event selectors for a trail.\n\nYou cannot apply both event selectors and advanced event selectors to a trail.",
|
|
7025
7055
|
"properties": {
|
|
7026
7056
|
"DataResources": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.\n\nFor more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide* .",
|
|
7027
|
-
"ExcludeManagementEventSources": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing `kms.amazonaws.com` or `rdsdata.amazonaws.com` . By default, `ExcludeManagementEventSources` is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail.",
|
|
7057
|
+
"ExcludeManagementEventSources": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing `kms.amazonaws.com` or `rdsdata.amazonaws.com` . By default, `ExcludeManagementEventSources` is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.",
|
|
7028
7058
|
"IncludeManagementEvents": "Specify if you want your event selector to include management events for your trail.\n\nFor more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) in the *AWS CloudTrail User Guide* .\n\nBy default, the value is `true` .\n\nThe first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://docs.aws.amazon.com/cloudtrail/pricing/) .",
|
|
7029
7059
|
"ReadWriteType": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 `GetConsoleOutput` is a read-only API operation and `RunInstances` is a write-only API operation.\n\nBy default, the value is `All` ."
|
|
7030
7060
|
}
|
|
@@ -8315,18 +8345,18 @@
|
|
|
8315
8345
|
},
|
|
8316
8346
|
"AWS::Cognito::UserPool.CustomEmailSender": {
|
|
8317
8347
|
"attributes": {},
|
|
8318
|
-
"description": "",
|
|
8348
|
+
"description": "A custom email sender AWS Lambda trigger.",
|
|
8319
8349
|
"properties": {
|
|
8320
|
-
"LambdaArn": "",
|
|
8321
|
-
"LambdaVersion": ""
|
|
8350
|
+
"LambdaArn": "The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Cognito triggers to send email notifications to users.",
|
|
8351
|
+
"LambdaVersion": "The Lambda version represents the signature of the \"request\" attribute in the \"event\" information that Amazon Cognito passes to your custom email sender AWS Lambda function. The only supported value is `V1_0` ."
|
|
8322
8352
|
}
|
|
8323
8353
|
},
|
|
8324
8354
|
"AWS::Cognito::UserPool.CustomSMSSender": {
|
|
8325
8355
|
"attributes": {},
|
|
8326
|
-
"description": "",
|
|
8356
|
+
"description": "A custom SMS sender AWS Lambda trigger.",
|
|
8327
8357
|
"properties": {
|
|
8328
|
-
"LambdaArn": "",
|
|
8329
|
-
"LambdaVersion": ""
|
|
8358
|
+
"LambdaArn": "The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Cognito triggers to send SMS notifications to users.",
|
|
8359
|
+
"LambdaVersion": "The Lambda version represents the signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your custom SMS sender Lambda function. The only supported value is `V1_0` ."
|
|
8330
8360
|
}
|
|
8331
8361
|
},
|
|
8332
8362
|
"AWS::Cognito::UserPool.DeviceConfiguration": {
|
|
@@ -8362,11 +8392,11 @@
|
|
|
8362
8392
|
"description": "Specifies the configuration for AWS Lambda triggers.",
|
|
8363
8393
|
"properties": {
|
|
8364
8394
|
"CreateAuthChallenge": "Creates an authentication challenge.",
|
|
8365
|
-
"CustomEmailSender": "",
|
|
8395
|
+
"CustomEmailSender": "A custom email sender AWS Lambda trigger.",
|
|
8366
8396
|
"CustomMessage": "A custom Message AWS Lambda trigger.",
|
|
8367
|
-
"CustomSMSSender": "",
|
|
8397
|
+
"CustomSMSSender": "A custom SMS sender AWS Lambda trigger.",
|
|
8368
8398
|
"DefineAuthChallenge": "Defines the authentication challenge.",
|
|
8369
|
-
"KMSKeyID": "",
|
|
8399
|
+
"KMSKeyID": "The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to `CustomEmailSender` and `CustomSMSSender` .",
|
|
8370
8400
|
"PostAuthentication": "A post-authentication AWS Lambda trigger.",
|
|
8371
8401
|
"PostConfirmation": "A post-confirmation AWS Lambda trigger.",
|
|
8372
8402
|
"PreAuthentication": "A pre-authentication AWS Lambda trigger.",
|
|
@@ -8498,7 +8528,7 @@
|
|
|
8498
8528
|
"attributes": {},
|
|
8499
8529
|
"description": "The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.\n\n> In Regions where Pinpoint isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region.",
|
|
8500
8530
|
"properties": {
|
|
8501
|
-
"ApplicationArn": "",
|
|
8531
|
+
"ApplicationArn": "The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen user pool client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.",
|
|
8502
8532
|
"ApplicationId": "The application ID for an Amazon Pinpoint application.",
|
|
8503
8533
|
"ExternalId": "The external ID.",
|
|
8504
8534
|
"RoleArn": "The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.",
|
|
@@ -8709,7 +8739,7 @@
|
|
|
8709
8739
|
},
|
|
8710
8740
|
"AWS::Config::AggregationAuthorization": {
|
|
8711
8741
|
"attributes": {
|
|
8712
|
-
"AggregationAuthorizationArn": "",
|
|
8742
|
+
"AggregationAuthorizationArn": "The Amazon Resource Name (ARN) of the aggregation object.",
|
|
8713
8743
|
"Ref": "`Ref` returns the ARN of the AggregationAuthorization, such as `arn:aws:config:us-east-1:123456789012:aggregation-authorization/987654321012/us-west-2` ."
|
|
8714
8744
|
},
|
|
8715
8745
|
"description": "An object that represents the authorizations granted to aggregator accounts and regions.",
|
|
@@ -8766,7 +8796,7 @@
|
|
|
8766
8796
|
},
|
|
8767
8797
|
"AWS::Config::ConfigurationAggregator": {
|
|
8768
8798
|
"attributes": {
|
|
8769
|
-
"ConfigurationAggregatorArn": "",
|
|
8799
|
+
"ConfigurationAggregatorArn": "The Amazon Resource Name (ARN) of the aggregator.",
|
|
8770
8800
|
"Ref": "`Ref` returns the ConfigurationAggregatorName, such as `myConfigurationAggregator` ."
|
|
8771
8801
|
},
|
|
8772
8802
|
"description": "The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.",
|
|
@@ -8862,7 +8892,7 @@
|
|
|
8862
8892
|
"attributes": {
|
|
8863
8893
|
"Ref": "`Ref` returns the OrganizationConfigRuleName."
|
|
8864
8894
|
},
|
|
8865
|
-
"description": "An organization config rule that has information about config rules that AWS Config creates in member accounts.
|
|
8895
|
+
"description": "An organization config rule that has information about config rules that AWS Config creates in member accounts.Only a master account and a delegated administrator can create or update an organization config rule.\n\n`OrganizationConfigRule` resource enables organization service access through `EnableAWSServiceAccess` action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with `GetRole` action.\n\nWhen creating custom organization config rules using a centralized Lambda function, you will need to allow Lambda permissions to sub-accounts and you will need to create an IAM role will to pass to the Lambda function. For more information, see [How to Centrally Manage AWS Config Rules across Multiple AWS Accounts](https://docs.aws.amazon.com/devops/how-to-centrally-manage-aws-config-rules-across-multiple-aws-accounts/) .",
|
|
8866
8896
|
"properties": {
|
|
8867
8897
|
"ExcludedAccounts": "A comma-separated list of accounts excluded from organization config rule.",
|
|
8868
8898
|
"OrganizationConfigRuleName": "The name that you assign to organization config rule.",
|
|
@@ -8997,8 +9027,8 @@
|
|
|
8997
9027
|
},
|
|
8998
9028
|
"AWS::Config::StoredQuery": {
|
|
8999
9029
|
"attributes": {
|
|
9000
|
-
"QueryArn": "",
|
|
9001
|
-
"QueryId": "",
|
|
9030
|
+
"QueryArn": "Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.",
|
|
9031
|
+
"QueryId": "The ID of the query.",
|
|
9002
9032
|
"Ref": ""
|
|
9003
9033
|
},
|
|
9004
9034
|
"description": "Provides the details of a stored query.",
|
|
@@ -9641,6 +9671,7 @@
|
|
|
9641
9671
|
"EndpointType": "The type of endpoint. Valid values are `source` and `target` .",
|
|
9642
9672
|
"EngineName": "The type of engine for the endpoint. Valid values, depending on the `EndpointType` value, include `\"mysql\"` , `\"oracle\"` , `\"postgres\"` , `\"mariadb\"` , `\"aurora\"` , `\"aurora-postgresql\"` , `\"opensearch\"` , `\"redshift\"` , `\"s3\"` , `\"db2\"` , `\"azuredb\"` , `\"sybase\"` , `\"dynamodb\"` , `\"mongodb\"` , `\"kinesis\"` , `\"kafka\"` , `\"elasticsearch\"` , `\"docdb\"` , `\"sqlserver\"` , and `\"neptune\"` .",
|
|
9643
9673
|
"ExtraConnectionAttributes": "Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide.*",
|
|
9674
|
+
"GcpMySQLSettings": "Settings in JSON format for the source GCP MySQL endpoint.",
|
|
9644
9675
|
"IbmDb2Settings": "Not currently supported by AWS CloudFormation .",
|
|
9645
9676
|
"KafkaSettings": "Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide.*",
|
|
9646
9677
|
"KinesisSettings": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see [Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the *AWS Database Migration Service User Guide.*",
|
|
@@ -9689,6 +9720,25 @@
|
|
|
9689
9720
|
"ServiceAccessRoleArn": "The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the `iam:PassRole` action."
|
|
9690
9721
|
}
|
|
9691
9722
|
},
|
|
9723
|
+
"AWS::DMS::Endpoint.GcpMySQLSettings": {
|
|
9724
|
+
"attributes": {},
|
|
9725
|
+
"description": "Settings in JSON format for the source GCP MySQL endpoint.",
|
|
9726
|
+
"properties": {
|
|
9727
|
+
"AfterConnectScript": "Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.\n\nFor this parameter, provide the code of the script itself, not the name of a file containing the script.",
|
|
9728
|
+
"CleanSourceMetadataOnMismatch": "Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to `false` .",
|
|
9729
|
+
"DatabaseName": "Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the `DatabaseName` request parameter on either the `CreateEndpoint` or `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.",
|
|
9730
|
+
"EventsPollInterval": "Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.\n\nExample: `eventsPollInterval=5;`\n\nIn the example, AWS DMS checks for changes in the binary logs every five seconds.",
|
|
9731
|
+
"MaxFileSize": "Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.\n\nExample: `maxFileSize=512`",
|
|
9732
|
+
"ParallelLoadThreads": "Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.\n\nExample: `parallelLoadThreads=1`",
|
|
9733
|
+
"Password": "Endpoint connection password.",
|
|
9734
|
+
"Port": "",
|
|
9735
|
+
"SecretsManagerAccessRoleArn": "The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.\n\n> You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId` . Or you can specify clear-text values for `UserName` , `Password` , `ServerName` , and `Port` . You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide.",
|
|
9736
|
+
"SecretsManagerSecretId": "The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.",
|
|
9737
|
+
"ServerName": "Endpoint TCP port.",
|
|
9738
|
+
"ServerTimezone": "Specifies the time zone for the source MySQL database.\n\nExample: `serverTimezone=US/Pacific;`\n\nNote: Do not enclose time zones in single quotes.",
|
|
9739
|
+
"Username": "Endpoint connection user name."
|
|
9740
|
+
}
|
|
9741
|
+
},
|
|
9692
9742
|
"AWS::DMS::Endpoint.IbmDb2Settings": {
|
|
9693
9743
|
"attributes": {},
|
|
9694
9744
|
"description": "Not currently supported by AWS CloudFormation .",
|
|
@@ -10921,12 +10971,14 @@
|
|
|
10921
10971
|
"AuthenticationOptions": "Information about the authentication method to be used to authenticate clients.",
|
|
10922
10972
|
"ClientCidrBlock": "The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.",
|
|
10923
10973
|
"ClientConnectOptions": "The options for managing connection authorization for new client connections.",
|
|
10974
|
+
"ClientLoginBannerOptions": "Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.",
|
|
10924
10975
|
"ConnectionLogOptions": "Information about the client connection logging options.\n\nIf you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:\n\n- Client connection requests\n- Client connection results (successful and unsuccessful)\n- Reasons for unsuccessful client connection requests\n- Client connection termination time",
|
|
10925
10976
|
"Description": "A brief description of the Client VPN endpoint.",
|
|
10926
10977
|
"DnsServers": "Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.",
|
|
10927
10978
|
"SecurityGroupIds": "The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.",
|
|
10928
10979
|
"SelfServicePortal": "Specify whether to enable the self-service portal for the Client VPN endpoint.\n\nDefault Value: `enabled`",
|
|
10929
10980
|
"ServerCertificateArn": "The ARN of the server certificate. For more information, see the [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/) .",
|
|
10981
|
+
"SessionTimeoutHours": "The maximum VPN session duration time in hours.\n\nValid values: `8 | 10 | 12 | 24`\n\nDefault value: `24`",
|
|
10930
10982
|
"SplitTunnel": "Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.\n\nBy default, split-tunnel on a VPN endpoint is disabled.\n\nFor information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the *AWS Client VPN Administrator Guide* .",
|
|
10931
10983
|
"TagSpecifications": "The tags to apply to the Client VPN endpoint during creation.",
|
|
10932
10984
|
"TransportProtocol": "The transport protocol to be used by the VPN session.\n\nDefault value: `udp`",
|
|
@@ -10959,6 +11011,14 @@
|
|
|
10959
11011
|
"LambdaFunctionArn": "The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization."
|
|
10960
11012
|
}
|
|
10961
11013
|
},
|
|
11014
|
+
"AWS::EC2::ClientVpnEndpoint.ClientLoginBannerOptions": {
|
|
11015
|
+
"attributes": {},
|
|
11016
|
+
"description": "Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.",
|
|
11017
|
+
"properties": {
|
|
11018
|
+
"BannerText": "Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.",
|
|
11019
|
+
"Enabled": "Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.\n\nValid values: `true | false`\n\nDefault value: `false`"
|
|
11020
|
+
}
|
|
11021
|
+
},
|
|
10962
11022
|
"AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions": {
|
|
10963
11023
|
"attributes": {},
|
|
10964
11024
|
"description": "Describes the client connection logging options for the Client VPN endpoint.",
|
|
@@ -11344,6 +11404,7 @@
|
|
|
11344
11404
|
},
|
|
11345
11405
|
"AWS::EC2::Host": {
|
|
11346
11406
|
"attributes": {
|
|
11407
|
+
"HostId": "The ID of the host.",
|
|
11347
11408
|
"Ref": "`Ref` returns the host ID, such as `h-0ab123c45d67ef89` ."
|
|
11348
11409
|
},
|
|
11349
11410
|
"description": "Allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see [Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
@@ -11360,8 +11421,8 @@
|
|
|
11360
11421
|
"IpamId": "The ID of the IPAM.",
|
|
11361
11422
|
"PrivateDefaultScopeId": "The ID of the IPAM's default private scope.",
|
|
11362
11423
|
"PublicDefaultScopeId": "The ID of the IPAM's default public scope.",
|
|
11363
|
-
"Ref": "",
|
|
11364
|
-
"ScopeCount": "The number of scopes in the IPAM."
|
|
11424
|
+
"Ref": "`Ref` returns the IPAM ID.",
|
|
11425
|
+
"ScopeCount": "The number of scopes in the IPAM. The scope quota is 5."
|
|
11365
11426
|
},
|
|
11366
11427
|
"description": "IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
11367
11428
|
"properties": {
|
|
@@ -11379,27 +11440,27 @@
|
|
|
11379
11440
|
},
|
|
11380
11441
|
"AWS::EC2::IPAMAllocation": {
|
|
11381
11442
|
"attributes": {
|
|
11382
|
-
"IpamPoolAllocationId": "The ID of
|
|
11383
|
-
"Ref": ""
|
|
11443
|
+
"IpamPoolAllocationId": "The ID of an allocation.",
|
|
11444
|
+
"Ref": "`Ref` returns the pool ID, allocation ID, and CIDR."
|
|
11384
11445
|
},
|
|
11385
|
-
"description": "",
|
|
11446
|
+
"description": "In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.",
|
|
11386
11447
|
"properties": {
|
|
11387
11448
|
"Cidr": "The CIDR you would like to allocate from the IPAM pool. Note the following:\n\n- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.\n- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.\n\nPossible values: Any available IPv4 or IPv6 CIDR.",
|
|
11388
|
-
"Description": "A description
|
|
11449
|
+
"Description": "A description for the allocation.",
|
|
11389
11450
|
"IpamPoolId": "The ID of the IPAM pool from which you would like to allocate a CIDR.",
|
|
11390
11451
|
"NetmaskLength": "The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:\n\n- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.\n- If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.\n\nPossible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128."
|
|
11391
11452
|
}
|
|
11392
11453
|
},
|
|
11393
11454
|
"AWS::EC2::IPAMPool": {
|
|
11394
11455
|
"attributes": {
|
|
11395
|
-
"Arn": "The ARN of the IPAM.",
|
|
11396
|
-
"IpamArn": "The ARN of the IPAM
|
|
11456
|
+
"Arn": "The ARN of the IPAM pool.",
|
|
11457
|
+
"IpamArn": "The ARN of the IPAM.",
|
|
11397
11458
|
"IpamPoolId": "The ID of the IPAM pool.",
|
|
11398
11459
|
"IpamScopeArn": "The ARN of the scope of the IPAM pool.",
|
|
11399
|
-
"IpamScopeType": "The
|
|
11400
|
-
"PoolDepth": "The depth of pools in your IPAM pool.",
|
|
11401
|
-
"Ref": "",
|
|
11402
|
-
"State": "The state of the IPAM pool
|
|
11460
|
+
"IpamScopeType": "The scope of the IPAM.",
|
|
11461
|
+
"PoolDepth": "The depth of pools in your IPAM pool. The pool depth quota is 10.",
|
|
11462
|
+
"Ref": "`Ref` returns the IPAM pool ID.",
|
|
11463
|
+
"State": "The state of the IPAM pool.",
|
|
11403
11464
|
"StateMessage": "A message related to the failed creation of an IPAM pool."
|
|
11404
11465
|
},
|
|
11405
11466
|
"description": "In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.",
|
|
@@ -11411,9 +11472,9 @@
|
|
|
11411
11472
|
"AllocationResourceTags": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.",
|
|
11412
11473
|
"AutoImport": "If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n\nA locale must be set on the pool for this feature to work.",
|
|
11413
11474
|
"Description": "The description of the IPAM pool.",
|
|
11414
|
-
"IpamScopeId": "",
|
|
11475
|
+
"IpamScopeId": "The ID of the scope in which you would like to create the IPAM pool.",
|
|
11415
11476
|
"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.",
|
|
11416
|
-
"ProvisionedCidrs": "",
|
|
11477
|
+
"ProvisionedCidrs": "Information about the CIDRs provisioned to an IPAM pool.",
|
|
11417
11478
|
"PubliclyAdvertisable": "Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to `ipv4` .",
|
|
11418
11479
|
"SourceIpamPoolId": "The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.",
|
|
11419
11480
|
"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."
|
|
@@ -11421,24 +11482,24 @@
|
|
|
11421
11482
|
},
|
|
11422
11483
|
"AWS::EC2::IPAMPool.ProvisionedCidr": {
|
|
11423
11484
|
"attributes": {},
|
|
11424
|
-
"description": "",
|
|
11485
|
+
"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` .",
|
|
11425
11486
|
"properties": {
|
|
11426
|
-
"Cidr": ""
|
|
11487
|
+
"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` ."
|
|
11427
11488
|
}
|
|
11428
11489
|
},
|
|
11429
11490
|
"AWS::EC2::IPAMScope": {
|
|
11430
11491
|
"attributes": {
|
|
11431
11492
|
"Arn": "The ARN of the scope.",
|
|
11432
|
-
"IpamArn": "The ARN of
|
|
11433
|
-
"IpamScopeId": "The ID of
|
|
11434
|
-
"IsDefault": "
|
|
11435
|
-
"PoolCount": "The number of pools in
|
|
11436
|
-
"Ref": ""
|
|
11493
|
+
"IpamArn": "The ARN of an IPAM.",
|
|
11494
|
+
"IpamScopeId": "The ID of an IPAM scope.",
|
|
11495
|
+
"IsDefault": "Defines if the scope is the default scope or not.",
|
|
11496
|
+
"PoolCount": "The number of pools in a scope.",
|
|
11497
|
+
"Ref": "`Ref` returns the IPAM scope ID."
|
|
11437
11498
|
},
|
|
11438
11499
|
"description": "In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.\n\nFor more information, see [How IPAM works](https://docs.aws.amazon.com//vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User Guide*",
|
|
11439
11500
|
"properties": {
|
|
11440
11501
|
"Description": "The description of the scope.",
|
|
11441
|
-
"IpamId": "",
|
|
11502
|
+
"IpamId": "The ID of the IPAM for which you're creating this scope.",
|
|
11442
11503
|
"IpamScopeType": "The type of the scope.",
|
|
11443
11504
|
"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."
|
|
11444
11505
|
}
|
|
@@ -13198,7 +13259,7 @@
|
|
|
13198
13259
|
"description": "Specifies a VPC attachment.",
|
|
13199
13260
|
"properties": {
|
|
13200
13261
|
"AddSubnetIds": "The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.",
|
|
13201
|
-
"Options": "The VPC attachment options.\n\n- DnsSupport (enable | disable)\n- Ipv6Support (enable| disable)\n- ApplianceModeSupport (enable | disable)",
|
|
13262
|
+
"Options": "The VPC attachment options in JSON or YAML.\n\n- DnsSupport (enable | disable)\n- Ipv6Support (enable| disable)\n- ApplianceModeSupport (enable | disable)",
|
|
13202
13263
|
"RemoveSubnetIds": "The IDs of one or more subnets to remove.",
|
|
13203
13264
|
"SubnetIds": "The IDs of the subnets.",
|
|
13204
13265
|
"Tags": "The tags for the VPC attachment.",
|
|
@@ -13215,14 +13276,14 @@
|
|
|
13215
13276
|
"Ipv6CidrBlocks": "The IPv6 CIDR blocks that are associated with the VPC, such as `[ 2001:db8:1234:1a00::/56 ]` .",
|
|
13216
13277
|
"Ref": "`Ref` returns the ID of the VPC."
|
|
13217
13278
|
},
|
|
13218
|
-
"description": "Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see [
|
|
13279
|
+
"description": "Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see [Overview of VPCs and subnets](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in the *Amazon Virtual Private Cloud User Guide* .",
|
|
13219
13280
|
"properties": {
|
|
13220
13281
|
"CidrBlock": "The primary IPv4 CIDR block for the VPC.",
|
|
13221
|
-
"EnableDnsHostnames": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS
|
|
13222
|
-
"EnableDnsSupport": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS
|
|
13282
|
+
"EnableDnsHostnames": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .\n\nYou can only enable DNS hostnames if you've enabled DNS support.",
|
|
13283
|
+
"EnableDnsSupport": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .",
|
|
13223
13284
|
"InstanceTenancy": "The allowed tenancy of instances launched into the VPC.\n\n- `\"default\"` : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n- `\"dedicated\"` : An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.\n\nUpdating `InstanceTenancy` requires no replacement only if you are updating its value from `\"dedicated\"` to `\"default\"` . Updating `InstanceTenancy` from `\"default\"` to `\"dedicated\"` requires replacement.",
|
|
13224
|
-
"Ipv4IpamPoolId": "",
|
|
13225
|
-
"Ipv4NetmaskLength": "",
|
|
13285
|
+
"Ipv4IpamPoolId": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13286
|
+
"Ipv4NetmaskLength": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13226
13287
|
"Tags": "The tags for the VPC."
|
|
13227
13288
|
}
|
|
13228
13289
|
},
|
|
@@ -13234,11 +13295,11 @@
|
|
|
13234
13295
|
"properties": {
|
|
13235
13296
|
"AmazonProvidedIpv6CidrBlock": "Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.",
|
|
13236
13297
|
"CidrBlock": "An IPv4 CIDR block to associate with the VPC.",
|
|
13237
|
-
"Ipv4IpamPoolId": "",
|
|
13238
|
-
"Ipv4NetmaskLength": "",
|
|
13298
|
+
"Ipv4IpamPoolId": "Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13299
|
+
"Ipv4NetmaskLength": "The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13239
13300
|
"Ipv6CidrBlock": "An IPv6 CIDR block from the IPv6 address pool. You must also specify `Ipv6Pool` in the request.\n\nTo let Amazon choose the IPv6 CIDR block for you, omit this parameter.",
|
|
13240
|
-
"Ipv6IpamPoolId": "",
|
|
13241
|
-
"Ipv6NetmaskLength": "",
|
|
13301
|
+
"Ipv6IpamPoolId": "Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13302
|
+
"Ipv6NetmaskLength": "The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13242
13303
|
"Ipv6Pool": "The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.",
|
|
13243
13304
|
"VpcId": "The ID of the VPC."
|
|
13244
13305
|
}
|
|
@@ -13378,6 +13439,7 @@
|
|
|
13378
13439
|
},
|
|
13379
13440
|
"AWS::EC2::VPNGatewayRoutePropagation": {
|
|
13380
13441
|
"attributes": {
|
|
13442
|
+
"Id": "The ID of the VPN gateway.",
|
|
13381
13443
|
"Ref": "`Ref` returns the ID of the VPN gateway."
|
|
13382
13444
|
},
|
|
13383
13445
|
"description": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.\n\nIf you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The `AWS::EC2::VPNGatewayRoutePropagation` resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::VPNGatewayRoutePropagation` resource to explicitly declare a dependency on the VPN gateway attachment.",
|
|
@@ -13881,7 +13943,7 @@
|
|
|
13881
13943
|
},
|
|
13882
13944
|
"AWS::ECS::TaskDefinition.EphemeralStorage": {
|
|
13883
13945
|
"attributes": {},
|
|
13884
|
-
"description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate . For more information, see [Fargate task storage](https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the *Amazon ECS User Guide for AWS Fargate* .\n\n> This parameter is only supported for tasks hosted on Fargate using
|
|
13946
|
+
"description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate . For more information, see [Fargate task storage](https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the *Amazon ECS User Guide for AWS Fargate* .\n\n> This parameter is only supported for tasks hosted on Fargate using Linux platform version `1.4.0` or later. This parameter is not supported for Windows containers on Fargate.",
|
|
13885
13947
|
"properties": {
|
|
13886
13948
|
"SizeInGiB": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB."
|
|
13887
13949
|
}
|
|
@@ -14143,13 +14205,13 @@
|
|
|
14143
14205
|
"attributes": {
|
|
14144
14206
|
"AccessPointId": "The ID of the EFS access point.",
|
|
14145
14207
|
"Arn": "The Amazon Resource Name (ARN) of the access point.",
|
|
14146
|
-
"Ref": "`Ref` returns the
|
|
14208
|
+
"Ref": "`Ref` returns the AccessPoint ID. For example:\n\n`{\"Ref\":\"access_point-logical_id\"}` returns\n\n`fsap-0123456789abcdef0`"
|
|
14147
14209
|
},
|
|
14148
14210
|
"description": "The `AWS::EFS::AccessPoint` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) .\n\nThis operation requires permissions for the `elasticfilesystem:CreateAccessPoint` action.",
|
|
14149
14211
|
"properties": {
|
|
14150
14212
|
"AccessPointTags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
|
14151
14213
|
"ClientToken": "The opaque string specified in the request to ensure idempotent creation.",
|
|
14152
|
-
"FileSystemId": "The ID of the EFS file system that the access point applies to.",
|
|
14214
|
+
"FileSystemId": "The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example `fs-0123456789abcedf2` .",
|
|
14153
14215
|
"PosixUser": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.",
|
|
14154
14216
|
"RootDirectory": "The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point."
|
|
14155
14217
|
}
|
|
@@ -14190,15 +14252,15 @@
|
|
|
14190
14252
|
},
|
|
14191
14253
|
"AWS::EFS::FileSystem": {
|
|
14192
14254
|
"attributes": {
|
|
14193
|
-
"Arn": "The Amazon Resource Name (ARN) of the EFS file system
|
|
14255
|
+
"Arn": "The Amazon Resource Name (ARN) of the EFS file system.\n\nExample: `arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8`",
|
|
14194
14256
|
"FileSystemId": "The ID of the EFS file system. For example: `fs-12345678`",
|
|
14195
|
-
"Ref": "`Ref` returns the
|
|
14257
|
+
"Ref": "`Ref` returns the FileSystem ID. For example:\n\n`{\"Ref\":\"file_system-logical_id\"}` returns\n\n`fs-0123456789abcdef2`"
|
|
14196
14258
|
},
|
|
14197
14259
|
"description": "The `AWS::EFS::FileSystem` resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ). You must create a mount target ( [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) ) to mount your EFS file system on an Amazon EC2 or other AWS cloud compute resource.",
|
|
14198
14260
|
"properties": {
|
|
14199
14261
|
"AvailabilityZoneName": "Used to create a file system that uses One Zone storage classes. It specifies the AWS Availability Zone in which to create the file system. Use the format `us-east-1a` to specify the Availability Zone. For more information about One Zone storage classes, see [Using EFS storage classes](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide* .\n\n> One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.",
|
|
14200
14262
|
"BackupPolicy": "Use the `BackupPolicy` to turn automatic backups on or off for the file system.",
|
|
14201
|
-
"BypassPolicyLockoutSafetyCheck": "",
|
|
14263
|
+
"BypassPolicyLockoutSafetyCheck": "(Optional) Use this boolean to use or bypass the `FileSystemPolicy` lockout safety check. The policy lockout safety check determines if the `FileSystemPolicy` in the request will lock out the IAM principal making the request, preventing them from making future `PutFileSystemPolicy` requests on the file system. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system. The default value is `False` .",
|
|
14202
14264
|
"Encrypted": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , `/aws/elasticfilesystem` , is used to protect the encrypted file system.",
|
|
14203
14265
|
"FileSystemPolicy": "The `FileSystemPolicy` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using IAM to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide* .",
|
|
14204
14266
|
"FileSystemTags": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a `\"Key\":\"Name\",\"Value\":\"{value}\"` key-value pair. Each key must be unique. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference Guide* .",
|
|
@@ -14234,9 +14296,9 @@
|
|
|
14234
14296
|
},
|
|
14235
14297
|
"AWS::EFS::MountTarget": {
|
|
14236
14298
|
"attributes": {
|
|
14237
|
-
"Id": "",
|
|
14238
|
-
"IpAddress": "The IPv4 address of the mount target.",
|
|
14239
|
-
"Ref": "`Ref` returns the
|
|
14299
|
+
"Id": "The ID of the Amazon EFS file system that the mount target provides access to.\n\nExample: `fs-0123456789111222a`",
|
|
14300
|
+
"IpAddress": "The IPv4 address of the mount target.\n\nExample: 192.0.2.0",
|
|
14301
|
+
"Ref": "`Ref` returns the MountTarget ID. For example:\n\n`{\"Ref\":\"logical_mount_target_id\"}` returns\n\n`fsmt-0123456789abcdef8` ."
|
|
14240
14302
|
},
|
|
14241
14303
|
"description": "The `AWS::EFS::MountTarget` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.",
|
|
14242
14304
|
"properties": {
|
|
@@ -14303,9 +14365,9 @@
|
|
|
14303
14365
|
"attributes": {},
|
|
14304
14366
|
"description": "The Kubernetes network configuration for the cluster.",
|
|
14305
14367
|
"properties": {
|
|
14306
|
-
"IpFamily": "Specify which IP family is used to assign Kubernetes
|
|
14368
|
+
"IpFamily": "Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, `ipv4` is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify `ipv6` , the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them.\n\nYou can only specify `ipv6` for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify `ipv6` , then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide. Kubernetes assigns services IPv6 addresses from the unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from the subnet's IPv6 CIDR.",
|
|
14307
14369
|
"ServiceIpv4Cidr": "Don't specify a value if you select `ipv6` for *ipFamily* . The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:\n\n- Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.\n- Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.\n- Between /24 and /12.\n\n> You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.",
|
|
14308
|
-
"ServiceIpv6Cidr": "The CIDR block that Kubernetes
|
|
14370
|
+
"ServiceIpv6Cidr": "The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified `ipv6` for *ipFamily* when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( `fc00::/7` ) because you can't specify a custom IPv6 CIDR block when you create the cluster."
|
|
14309
14371
|
}
|
|
14310
14372
|
},
|
|
14311
14373
|
"AWS::EKS::Cluster.Logging": {
|
|
@@ -14746,9 +14808,9 @@
|
|
|
14746
14808
|
"attributes": {},
|
|
14747
14809
|
"description": "`VolumeSpecification` is a subproperty of the `EbsBlockDeviceConfig` property type. `VolumeSecification` determines the volume type, IOPS, and size (GiB) for EBS volumes attached to EC2 instances.",
|
|
14748
14810
|
"properties": {
|
|
14749
|
-
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.
|
|
14811
|
+
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.",
|
|
14750
14812
|
"SizeInGB": "The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.",
|
|
14751
|
-
"VolumeType": "The volume type. Volume types supported are gp2, io1,
|
|
14813
|
+
"VolumeType": "The volume type. Volume types supported are gp2, io1, and standard."
|
|
14752
14814
|
}
|
|
14753
14815
|
},
|
|
14754
14816
|
"AWS::EMR::InstanceFleetConfig": {
|
|
@@ -14833,9 +14895,9 @@
|
|
|
14833
14895
|
"attributes": {},
|
|
14834
14896
|
"description": "`VolumeSpecification` is a subproperty of the `EbsBlockDeviceConfig` property type. `VolumeSecification` determines the volume type, IOPS, and size (GiB) for EBS volumes attached to EC2 instances.",
|
|
14835
14897
|
"properties": {
|
|
14836
|
-
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.
|
|
14898
|
+
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.",
|
|
14837
14899
|
"SizeInGB": "The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.",
|
|
14838
|
-
"VolumeType": "The volume type. Volume types supported are gp2, io1,
|
|
14900
|
+
"VolumeType": "The volume type. Volume types supported are gp2, io1, and standard."
|
|
14839
14901
|
}
|
|
14840
14902
|
},
|
|
14841
14903
|
"AWS::EMR::InstanceGroupConfig": {
|
|
@@ -14959,9 +15021,9 @@
|
|
|
14959
15021
|
"attributes": {},
|
|
14960
15022
|
"description": "`VolumeSpecification` is a subproperty of the `EbsBlockDeviceConfig` property type. `VolumeSecification` determines the volume type, IOPS, and size (GiB) for EBS volumes attached to EC2 instances.",
|
|
14961
15023
|
"properties": {
|
|
14962
|
-
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.
|
|
15024
|
+
"Iops": "The number of I/O operations per second (IOPS) that the volume supports.",
|
|
14963
15025
|
"SizeInGB": "The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.",
|
|
14964
|
-
"VolumeType": "The volume type. Volume types supported are gp2, io1,
|
|
15026
|
+
"VolumeType": "The volume type. Volume types supported are gp2, io1, and standard."
|
|
14965
15027
|
}
|
|
14966
15028
|
},
|
|
14967
15029
|
"AWS::EMR::SecurityConfiguration": {
|
|
@@ -15137,7 +15199,7 @@
|
|
|
15137
15199
|
"DestinationDetails": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.",
|
|
15138
15200
|
"DestinationType": "Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either `cloudwatch-logs` or `kinesis-firehose` .",
|
|
15139
15201
|
"LogFormat": "Valid values are either `json` or `text` .",
|
|
15140
|
-
"LogType": "Valid value is `slow-log`
|
|
15202
|
+
"LogType": "Valid value is either `slow-log` , which refers to [slow-log](https://docs.aws.amazon.com/https://redis.io/commands/slowlog) or `engine-log` ."
|
|
15141
15203
|
}
|
|
15142
15204
|
},
|
|
15143
15205
|
"AWS::ElastiCache::GlobalReplicationGroup": {
|
|
@@ -15246,7 +15308,7 @@
|
|
|
15246
15308
|
"SnapshotWindow": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).\n\nExample: `05:00-09:00`\n\nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.",
|
|
15247
15309
|
"SnapshottingClusterId": "The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.",
|
|
15248
15310
|
"Tags": "A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key= `myKey` , Value= `myKeyValue` . You can include multiple tags as shown following: Key= `myKey` , Value= `myKeyValue` Key= `mySecondKey` , Value= `mySecondKeyValue` . Tags on replication groups will be replicated to all nodes.",
|
|
15249
|
-
"TransitEncryptionEnabled": "A flag that enables in-transit encryption when set to `true` .\n\nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created. To enable in-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster.\n\nThis parameter is valid only if the `Engine` parameter is `redis` , the `EngineVersion` parameter is `3.2.6` or `4.x`
|
|
15311
|
+
"TransitEncryptionEnabled": "A flag that enables in-transit encryption when set to `true` .\n\nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created. To enable in-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster.\n\nThis parameter is valid only if the `Engine` parameter is `redis` , the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC.\n\nIf you enable in-transit encryption, you must also specify a value for `CacheSubnetGroup` .\n\n*Required:* Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward.\n\nDefault: `false`\n\n> For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true` , an `AuthToken` , and a `CacheSubnetGroup` .",
|
|
15250
15312
|
"UserGroupIds": "The list of user groups to associate with the replication group."
|
|
15251
15313
|
}
|
|
15252
15314
|
},
|
|
@@ -15261,7 +15323,7 @@
|
|
|
15261
15323
|
"attributes": {},
|
|
15262
15324
|
"description": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.",
|
|
15263
15325
|
"properties": {
|
|
15264
|
-
"CloudWatchLogsDetails": "",
|
|
15326
|
+
"CloudWatchLogsDetails": "The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.",
|
|
15265
15327
|
"KinesisFirehoseDetails": "The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination."
|
|
15266
15328
|
}
|
|
15267
15329
|
},
|
|
@@ -15279,7 +15341,7 @@
|
|
|
15279
15341
|
"DestinationDetails": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.",
|
|
15280
15342
|
"DestinationType": "Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either `cloudwatch-logs` or `kinesis-firehose` .",
|
|
15281
15343
|
"LogFormat": "Valid values are either `json` or `text` .",
|
|
15282
|
-
"LogType": "Valid value is `slow-log`
|
|
15344
|
+
"LogType": "Valid value is either `slow-log` , which refers to [slow-log](https://docs.aws.amazon.com/https://redis.io/commands/slowlog) or `engine-log` ."
|
|
15283
15345
|
}
|
|
15284
15346
|
},
|
|
15285
15347
|
"AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration": {
|
|
@@ -16793,12 +16855,12 @@
|
|
|
16793
16855
|
},
|
|
16794
16856
|
"AWS::FSx::FileSystem": {
|
|
16795
16857
|
"attributes": {
|
|
16796
|
-
"DNSName": "
|
|
16797
|
-
"LustreMountName": "
|
|
16798
|
-
"Ref": "`Ref` returns the
|
|
16799
|
-
"RootVolumeId": ""
|
|
16858
|
+
"DNSName": "Returns the FSx for Windows file system's DNSName.\n\nExample: `amznfsxp1honlek.corp.example.com`",
|
|
16859
|
+
"LustreMountName": "Returns the file system's LustreMountName.\n\nExample for SCRATCH_1 deployment types: This value is always `fsx` .\n\nExample for SCRATCH_2 and PERSISTENT deployment types: `2p3fhbmv`",
|
|
16860
|
+
"Ref": "`Ref` returns the file system resource ID. For example:\n\n`{\"Ref\":\"file_system_logical_id\"}`\n\nReturns `fs-0123456789abcdef6` .",
|
|
16861
|
+
"RootVolumeId": "Returns the root volume ID of the FSx for OpenZFS file system.\n\nExample: `fsvol-0123456789abcdefa`"
|
|
16800
16862
|
},
|
|
16801
|
-
"description": "The `AWS::FSx::FileSystem` resource is an Amazon FSx resource type that creates
|
|
16863
|
+
"description": "The `AWS::FSx::FileSystem` resource is an Amazon FSx resource type that creates an Amazon FSx file system. You can create any of the following supported file system types:\n\n- Amazon FSx for Lustre\n- Amazon FSx for NetApp ONTAP\n- Amazon FSx for OpenZFS\n- Amazon FSx for Windows File Server",
|
|
16802
16864
|
"properties": {
|
|
16803
16865
|
"BackupId": "The ID of the source backup. Specifies the backup that you are copying.",
|
|
16804
16866
|
"FileSystemType": "The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .",
|
|
@@ -16934,7 +16996,7 @@
|
|
|
16934
16996
|
"properties": {
|
|
16935
16997
|
"ActiveDirectoryId": "The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.",
|
|
16936
16998
|
"Aliases": "An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time.\n\nFor more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) and [Walkthrough 5: Using DNS aliases to access your file system](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html) , including additional steps you must take to be able to access your file system using a DNS alias.\n\nAn alias name has to meet the following requirements:\n\n- Formatted as a fully-qualified domain name (FQDN), `hostname.domain` , for example, `accounting.example.com` .\n- Can contain alphanumeric characters, the underscore (_), and the hyphen (-).\n- Cannot start or end with a hyphen.\n- Can start with a numeric.\n\nFor DNS alias names, Amazon FSx stores alphabetical characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.",
|
|
16937
|
-
"AuditLogConfiguration": "",
|
|
16999
|
+
"AuditLogConfiguration": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.",
|
|
16938
17000
|
"AutomaticBackupRetentionDays": "The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.",
|
|
16939
17001
|
"CopyTagsToBackups": "A Boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.",
|
|
16940
17002
|
"DailyAutomaticBackupStartTime": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.",
|
|
@@ -16947,8 +17009,8 @@
|
|
|
16947
17009
|
},
|
|
16948
17010
|
"AWS::FSx::Snapshot": {
|
|
16949
17011
|
"attributes": {
|
|
16950
|
-
"Ref": "",
|
|
16951
|
-
"ResourceARN": "
|
|
17012
|
+
"Ref": "`Ref` returns the ID of the snapshot. For example:\n\n`{\"Ref\":\"logical_snapshot_id\"}`\n\nReturns `fsvolsnap-0123456789abcedf5` .",
|
|
17013
|
+
"ResourceARN": "Returns the snapshot's Amazon Resource Name (ARN).\n\nExample: `arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5`"
|
|
16952
17014
|
},
|
|
16953
17015
|
"description": "A snapshot of an Amazon FSx for OpenZFS volume.",
|
|
16954
17016
|
"properties": {
|
|
@@ -16959,10 +17021,10 @@
|
|
|
16959
17021
|
},
|
|
16960
17022
|
"AWS::FSx::StorageVirtualMachine": {
|
|
16961
17023
|
"attributes": {
|
|
16962
|
-
"Ref": "",
|
|
16963
|
-
"ResourceARN": "
|
|
16964
|
-
"StorageVirtualMachineId": "
|
|
16965
|
-
"UUID": "
|
|
17024
|
+
"Ref": "`Ref` returns the resource ID, such as `svm-01234567890123456` . For example:\n\n`{\"Ref\": \"svm_logical_id\"}` returns\n\n`svm-01234567890123456`",
|
|
17025
|
+
"ResourceARN": "Returns the storage virtual machine's Amazon Resource Name (ARN).\n\nExample: `arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456`",
|
|
17026
|
+
"StorageVirtualMachineId": "Returns the storgage virtual machine's system generated ID.\n\nExample: `svm-0123456789abcedf1`",
|
|
17027
|
+
"UUID": "Returns the storage virtual machine's system generated unique identifier (UUID).\n\nExample: `abcd0123-cd45-ef67-11aa-1111aaaa23bc`"
|
|
16966
17028
|
},
|
|
16967
17029
|
"description": "Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.",
|
|
16968
17030
|
"properties": {
|
|
@@ -16996,10 +17058,10 @@
|
|
|
16996
17058
|
},
|
|
16997
17059
|
"AWS::FSx::Volume": {
|
|
16998
17060
|
"attributes": {
|
|
16999
|
-
"Ref": "",
|
|
17000
|
-
"ResourceARN": "
|
|
17001
|
-
"UUID": "
|
|
17002
|
-
"VolumeId": "
|
|
17061
|
+
"Ref": "`Ref` returns the ID for the volume. For example:\n\n`{\"Ref\":\"vol_logical_id\"}`\n\nReturns `fsvol-0123456789abcdef6` .",
|
|
17062
|
+
"ResourceARN": "Returns the volume's Amazon Resource Name (ARN).\n\nExample: `arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223`",
|
|
17063
|
+
"UUID": "Returns the volume's universally unique identifier (UUID).\n\nExample: `abcd0123-cd45-ef67-11aa-1111aaaa23bc`",
|
|
17064
|
+
"VolumeId": "Returns the volume's ID.\n\nExample: `fsvol-0123456789abcdefa`"
|
|
17003
17065
|
},
|
|
17004
17066
|
"description": "Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage volume.",
|
|
17005
17067
|
"properties": {
|
|
@@ -17866,6 +17928,14 @@
|
|
|
17866
17928
|
"Path": "The path of the JDBC target."
|
|
17867
17929
|
}
|
|
17868
17930
|
},
|
|
17931
|
+
"AWS::Glue::Crawler.MongoDBTarget": {
|
|
17932
|
+
"attributes": {},
|
|
17933
|
+
"description": "Specifies an Amazon DocumentDB or MongoDB data store to crawl.",
|
|
17934
|
+
"properties": {
|
|
17935
|
+
"ConnectionName": "The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.",
|
|
17936
|
+
"Path": "The path of the Amazon DocumentDB or MongoDB target (database/collection)."
|
|
17937
|
+
}
|
|
17938
|
+
},
|
|
17869
17939
|
"AWS::Glue::Crawler.RecrawlPolicy": {
|
|
17870
17940
|
"attributes": {},
|
|
17871
17941
|
"description": "When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see [Incremental Crawls in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) in the developer guide.",
|
|
@@ -17878,8 +17948,11 @@
|
|
|
17878
17948
|
"description": "Specifies a data store in Amazon Simple Storage Service (Amazon S3).",
|
|
17879
17949
|
"properties": {
|
|
17880
17950
|
"ConnectionName": "The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).",
|
|
17951
|
+
"DlqEventQueueArn": "",
|
|
17952
|
+
"EventQueueArn": "",
|
|
17881
17953
|
"Exclusions": "A list of glob patterns used to exclude from the crawl. For more information, see [Catalog Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) .",
|
|
17882
|
-
"Path": "The path to the Amazon S3 target."
|
|
17954
|
+
"Path": "The path to the Amazon S3 target.",
|
|
17955
|
+
"SampleSize": "Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249."
|
|
17883
17956
|
}
|
|
17884
17957
|
},
|
|
17885
17958
|
"AWS::Glue::Crawler.Schedule": {
|
|
@@ -17904,6 +17977,7 @@
|
|
|
17904
17977
|
"CatalogTargets": "Specifies AWS Glue Data Catalog targets.",
|
|
17905
17978
|
"DynamoDBTargets": "Specifies Amazon DynamoDB targets.",
|
|
17906
17979
|
"JdbcTargets": "Specifies JDBC targets.",
|
|
17980
|
+
"MongoDBTargets": "A list of Mongo DB targets.",
|
|
17907
17981
|
"S3Targets": "Specifies Amazon Simple Storage Service (Amazon S3) targets."
|
|
17908
17982
|
}
|
|
17909
17983
|
},
|
|
@@ -17980,10 +18054,10 @@
|
|
|
17980
18054
|
},
|
|
17981
18055
|
"AWS::Glue::Database.PrincipalPrivileges": {
|
|
17982
18056
|
"attributes": {},
|
|
17983
|
-
"description": "",
|
|
18057
|
+
"description": "the permissions granted to a principal",
|
|
17984
18058
|
"properties": {
|
|
17985
|
-
"Permissions": "",
|
|
17986
|
-
"Principal": ""
|
|
18059
|
+
"Permissions": "The permissions that are granted to the principal.",
|
|
18060
|
+
"Principal": "The principal who is granted permissions."
|
|
17987
18061
|
}
|
|
17988
18062
|
},
|
|
17989
18063
|
"AWS::Glue::DevEndpoint": {
|
|
@@ -20422,7 +20496,7 @@
|
|
|
20422
20496
|
"properties": {
|
|
20423
20497
|
"DisplayName": "Field that represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.",
|
|
20424
20498
|
"MetricName": "The name of the custom metric. This will be used in the metric report submitted from the device/thing. It shouldn't begin with `aws:` . Cannot be updated once it's defined.",
|
|
20425
|
-
"MetricType": "The type of the custom metric. Types include `string-list` , `ip-address-list` , `number-list`
|
|
20499
|
+
"MetricType": "The type of the custom metric. Types include `string-list` , `ip-address-list` , and `number-list` .",
|
|
20426
20500
|
"Tags": "Metadata that can be used to manage the custom metric."
|
|
20427
20501
|
}
|
|
20428
20502
|
},
|
|
@@ -20527,13 +20601,13 @@
|
|
|
20527
20601
|
},
|
|
20528
20602
|
"AWS::IoT::Logging": {
|
|
20529
20603
|
"attributes": {
|
|
20530
|
-
"Ref": ""
|
|
20604
|
+
"Ref": "`Ref` returns the log ID. For example:\n\n`{\"Ref\": \"Log-12345\"}`"
|
|
20531
20605
|
},
|
|
20532
|
-
"description": "",
|
|
20606
|
+
"description": "Configure logging.",
|
|
20533
20607
|
"properties": {
|
|
20534
|
-
"AccountId": "",
|
|
20535
|
-
"DefaultLogLevel": "",
|
|
20536
|
-
"RoleArn": ""
|
|
20608
|
+
"AccountId": "The account ID.",
|
|
20609
|
+
"DefaultLogLevel": "The default log level.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED`",
|
|
20610
|
+
"RoleArn": "The role ARN used for the log."
|
|
20537
20611
|
}
|
|
20538
20612
|
},
|
|
20539
20613
|
"AWS::IoT::MitigationAction": {
|
|
@@ -20651,14 +20725,14 @@
|
|
|
20651
20725
|
},
|
|
20652
20726
|
"AWS::IoT::ResourceSpecificLogging": {
|
|
20653
20727
|
"attributes": {
|
|
20654
|
-
"Ref": "",
|
|
20655
|
-
"TargetId": ""
|
|
20728
|
+
"Ref": "`Ref` returns the resource-specific log ID. For example:\n\n`{\"Ref\": \"MyResourceLog-12345\" }`",
|
|
20729
|
+
"TargetId": "The target Id."
|
|
20656
20730
|
},
|
|
20657
|
-
"description": "",
|
|
20731
|
+
"description": "Configure resource-specific logging.",
|
|
20658
20732
|
"properties": {
|
|
20659
|
-
"LogLevel": "",
|
|
20660
|
-
"TargetName": "",
|
|
20661
|
-
"TargetType": ""
|
|
20733
|
+
"LogLevel": "The default log level.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED`",
|
|
20734
|
+
"TargetName": "The target name.",
|
|
20735
|
+
"TargetType": "The target type. Valid Values: `DEFAULT | THING_GROUP`"
|
|
20662
20736
|
}
|
|
20663
20737
|
},
|
|
20664
20738
|
"AWS::IoT::ScheduledAudit": {
|
|
@@ -20753,10 +20827,10 @@
|
|
|
20753
20827
|
"properties": {
|
|
20754
20828
|
"Cidrs": "If the `comparisonOperator` calls for a set of CIDRs, use this to specify that set to be compared with the `metric` .",
|
|
20755
20829
|
"Count": "If the `comparisonOperator` calls for a numeric value, use this to specify that numeric value to be compared with the `metric` .",
|
|
20756
|
-
"Number": "",
|
|
20757
|
-
"Numbers": "",
|
|
20830
|
+
"Number": "The numeric values of a metric.",
|
|
20831
|
+
"Numbers": "The numeric value of a metric.",
|
|
20758
20832
|
"Ports": "If the `comparisonOperator` calls for a set of ports, use this to specify that set to be compared with the `metric` .",
|
|
20759
|
-
"Strings": ""
|
|
20833
|
+
"Strings": "The string values of a metric."
|
|
20760
20834
|
}
|
|
20761
20835
|
},
|
|
20762
20836
|
"AWS::IoT::SecurityProfile.StatisticalThreshold": {
|
|
@@ -20808,7 +20882,7 @@
|
|
|
20808
20882
|
"description": "Describes the actions associated with a rule.",
|
|
20809
20883
|
"properties": {
|
|
20810
20884
|
"CloudwatchAlarm": "Change the state of a CloudWatch alarm.",
|
|
20811
|
-
"CloudwatchLogs": "",
|
|
20885
|
+
"CloudwatchLogs": "Sends data to CloudWatch.",
|
|
20812
20886
|
"CloudwatchMetric": "Capture a CloudWatch metric.",
|
|
20813
20887
|
"DynamoDB": "Write to a DynamoDB table.",
|
|
20814
20888
|
"DynamoDBv2": "Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.",
|
|
@@ -20925,7 +20999,7 @@
|
|
|
20925
20999
|
"attributes": {},
|
|
20926
21000
|
"description": "Describes an action that writes data to an Amazon Kinesis Firehose stream.",
|
|
20927
21001
|
"properties": {
|
|
20928
|
-
"BatchMode": "",
|
|
21002
|
+
"BatchMode": "Whether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) . The default value is `false` .\n\nWhen `batchMode` is `true` and the rule's SQL statement evaluates to an Array, each Array element forms one record in the [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) request. The resulting array can't have more than 500 records.",
|
|
20929
21003
|
"DeliveryStreamName": "The delivery stream name.",
|
|
20930
21004
|
"RoleArn": "The IAM role that grants access to the Amazon Kinesis Firehose stream.",
|
|
20931
21005
|
"Separator": "A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."
|
|
@@ -20960,7 +21034,7 @@
|
|
|
20960
21034
|
"attributes": {},
|
|
20961
21035
|
"description": "Sends message data to an AWS IoT Analytics channel.",
|
|
20962
21036
|
"properties": {
|
|
20963
|
-
"BatchMode": "",
|
|
21037
|
+
"BatchMode": "Whether to process the action as a batch. The default value is `false` .\n\nWhen `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by [`BatchPutMessage`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) The resulting array can't have more than 100 messages.",
|
|
20964
21038
|
"ChannelName": "The name of the IoT Analytics channel to which message data will be sent.",
|
|
20965
21039
|
"RoleArn": "The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage)."
|
|
20966
21040
|
}
|
|
@@ -20969,7 +21043,7 @@
|
|
|
20969
21043
|
"attributes": {},
|
|
20970
21044
|
"description": "Sends an input to an AWS IoT Events detector.",
|
|
20971
21045
|
"properties": {
|
|
20972
|
-
"BatchMode": "",
|
|
21046
|
+
"BatchMode": "Whether to process the event actions as a batch. The default value is `false` .\n\nWhen `batchMode` is `true` , you can't specify a `messageId` .\n\nWhen `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling [`BatchPutMessage`](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html) . The resulting array can't have more than 10 messages.",
|
|
20973
21047
|
"InputName": "The name of the AWS IoT Events input.",
|
|
20974
21048
|
"MessageId": "The ID of the message. The default `messageId` is a new UUID value.\n\nWhen `batchMode` is `true` , you can't specify a `messageId` --a new UUID value will be assigned.\n\nAssign a value to this property to ensure that only one input (message) with a given `messageId` will be processed by an AWS IoT Events detector.",
|
|
20975
21049
|
"RoleArn": "The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. (\"Action\":\"iotevents:BatchPutMessage\")."
|
|
@@ -21098,7 +21172,7 @@
|
|
|
21098
21172
|
"attributes": {},
|
|
21099
21173
|
"description": "Describes an action that writes records into an Amazon Timestream table.",
|
|
21100
21174
|
"properties": {
|
|
21101
|
-
"BatchMode": "",
|
|
21175
|
+
"BatchMode": "Whether to process the action as a batch.",
|
|
21102
21176
|
"DatabaseName": "The name of an Amazon Timestream database that has the table to write records into.",
|
|
21103
21177
|
"Dimensions": "Metadata attributes of the time series that are written in each measure record.",
|
|
21104
21178
|
"RoleArn": "The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.",
|
|
@@ -21138,7 +21212,7 @@
|
|
|
21138
21212
|
"attributes": {
|
|
21139
21213
|
"Arn": "The topic rule destination URL.",
|
|
21140
21214
|
"Ref": "`Ref` returns the topic rule destination. For example:\n\n`{ \"Ref\": \"TopicRuleDestination\" }`\n\nA value similar to the following is returned:\n\n`a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2`",
|
|
21141
|
-
"StatusReason": ""
|
|
21215
|
+
"StatusReason": "Additional details or reason why the topic rule destination is in the current status."
|
|
21142
21216
|
},
|
|
21143
21217
|
"description": "A topic rule destination.",
|
|
21144
21218
|
"properties": {
|
|
@@ -22188,7 +22262,8 @@
|
|
|
22188
22262
|
"attributes": {},
|
|
22189
22263
|
"description": "Contains a gateway's platform information.",
|
|
22190
22264
|
"properties": {
|
|
22191
|
-
"Greengrass": "A gateway that runs on AWS IoT Greengrass ."
|
|
22265
|
+
"Greengrass": "A gateway that runs on AWS IoT Greengrass .",
|
|
22266
|
+
"GreengrassV2": ""
|
|
22192
22267
|
}
|
|
22193
22268
|
},
|
|
22194
22269
|
"AWS::IoTSiteWise::Gateway.Greengrass": {
|
|
@@ -22198,6 +22273,13 @@
|
|
|
22198
22273
|
"GroupArn": "The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Greengrass group. For more information about how to find a group's ARN, see [ListGroups](https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html) and [GetGroup](https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html) in the *AWS IoT Greengrass API Reference* ."
|
|
22199
22274
|
}
|
|
22200
22275
|
},
|
|
22276
|
+
"AWS::IoTSiteWise::Gateway.GreengrassV2": {
|
|
22277
|
+
"attributes": {},
|
|
22278
|
+
"description": "",
|
|
22279
|
+
"properties": {
|
|
22280
|
+
"CoreDeviceThingName": ""
|
|
22281
|
+
}
|
|
22282
|
+
},
|
|
22201
22283
|
"AWS::IoTSiteWise::Portal": {
|
|
22202
22284
|
"attributes": {
|
|
22203
22285
|
"PortalArn": "The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.\n\n`arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}`",
|
|
@@ -22603,7 +22685,7 @@
|
|
|
22603
22685
|
"attributes": {
|
|
22604
22686
|
"Ref": "`Ref` returns the alias name, such as `alias/exampleAlias` ."
|
|
22605
22687
|
},
|
|
22606
|
-
"description": "The `AWS::KMS::Alias` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) . You can use an alias to identify a KMS key in the AWS KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) , such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) .\n\n> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [
|
|
22688
|
+
"description": "The `AWS::KMS::Alias` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) . You can use an alias to identify a KMS key in the AWS KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) , such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) .\n\n> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* . \n\nUsing an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS Regions . For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *AWS Key Management Service Developer Guide* .\n\nWhen specifying an alias, observe the following rules.\n\n- Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.\n- The alias and its associated KMS key must be in the same AWS account and Region.\n- The alias name must be unique in the AWS account and Region. However, you can create aliases with the same name in different AWS Regions . For example, you can have an `alias/projectKey` in multiple Regions, each of which is associated with a KMS key in its Region.\n- Each alias name must begin with `alias/` followed by a name, such as `alias/exampleKey` . The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with `alias/aws/` . That alias name prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .",
|
|
22607
22689
|
"properties": {
|
|
22608
22690
|
"AliasName": "Specifies the alias name. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias` .\n\n> If you change the value of a `Replacement` property, such as `AliasName` , the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). \n\nThe alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with `alias/aws/` . The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .\n\n*Pattern* : `alias/^[a-zA-Z0-9/_-]+$`\n\n*Minimum* : `1`\n\n*Maximum* : `256`",
|
|
22609
22691
|
"TargetKeyId": "Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . The KMS key must be in the same AWS account and Region.\n\nA valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n\nFor help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide* .\n\nSpecify the key ID or the key ARN of the KMS key.\n\nFor example:\n\n- Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n- Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n\nTo get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) ."
|
|
@@ -22615,7 +22697,7 @@
|
|
|
22615
22697
|
"KeyId": "The key ID of the KMS key, such as `1234abcd-12ab-34cd-56ef-1234567890ab` .\n\nFor information about the key ID of a KMS key, see [Key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) in the *AWS Key Management Service Developer Guide* .",
|
|
22616
22698
|
"Ref": "`Ref` returns the key ID, such as `1234abcd-12ab-34cd-56ef-1234567890ab` ."
|
|
22617
22699
|
},
|
|
22618
|
-
"description": "The `AWS::KMS::Key` resource specifies a [symmetric or asymmetric](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in AWS Key Management Service ( AWS KMS ).\n\n> AWS KMS is replacing the term *customer master key (CMK)* with *AWS KMS key* and *KMS key* . The concept has not changed. To prevent breaking changes, AWS KMS is keeping some variations of this term. \n\nYou can use symmetric KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use symmetric KMS key to encrypt data stored in AWS services that are [integrated with AWS KMS](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration) . For more information, see [What is AWS Key Management Service ?](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric `KeySpec` value and a `KeyUsage` value.\n\n> If you change the value of a `Replacement` property, such as `KeyUsage` or `KeySpec` , on an existing KMS key, the existing KMS key is [scheduled for deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) and a new KMS key is created with the specified value.\n> \n> While scheduled for deletion, the existing KMS key becomes unusable. If you don't [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the existing KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.",
|
|
22700
|
+
"description": "The `AWS::KMS::Key` resource specifies a [symmetric or asymmetric](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in AWS Key Management Service ( AWS KMS ).\n\nYou can use the `AWS::KMS::Key` resource to specify a multi-Region primary key (symmetric or asymmetric). To specify a replica key, use the [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource. For information about multi-Region keys, see [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\n> AWS KMS is replacing the term *customer master key (CMK)* with *AWS KMS key* and *KMS key* . The concept has not changed. To prevent breaking changes, AWS KMS is keeping some variations of this term. \n\nYou can use symmetric KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use symmetric KMS key to encrypt data stored in AWS services that are [integrated with AWS KMS](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration) . For more information, see [What is AWS Key Management Service ?](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric `KeySpec` value and a `KeyUsage` value.\n\n> If you change the value of a `Replacement` property, such as `KeyUsage` or `KeySpec` , on an existing KMS key, the existing KMS key is [scheduled for deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) and a new KMS key is created with the specified value.\n> \n> While scheduled for deletion, the existing KMS key becomes unusable. If you don't [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the existing KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.",
|
|
22619
22701
|
"properties": {
|
|
22620
22702
|
"Description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.",
|
|
22621
22703
|
"EnableKeyRotation": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.\n\nAWS KMS does not support automatic key rotation on asymmetric KMS keys. For asymmetric KMS keys, omit the `EnableKeyRotation` property or set it to `false` .\n\nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key 365 days after the enable (or reenable) date and every 365 days thereafter. AWS KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide* .",
|
|
@@ -22623,9 +22705,9 @@
|
|
|
22623
22705
|
"KeyPolicy": "The key policy that authorizes use of the KMS key. The key policy must conform to the following rules.\n\n- The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n- The key policy size limit is 32 kilobytes (32768 bytes).\n\nIf you are unsure of which policy to use, consider the *default key policy* . This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
|
|
22624
22706
|
"KeySpec": "Specifies the type of KMS key to create. The default value, `SYMMETRIC_DEFAULT` , creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see [How to choose Your KMS key configuration](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide* .\n\nThe `KeySpec` property determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the KMS key supports. You can't change the `KeySpec` after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [kms:EncryptionAlgorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm) or [kms:Signing Algorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) in the *AWS Key Management Service Developer Guide* .\n\n> If you change the `KeySpec` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeySpec` value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. > [AWS services that are integrated with AWS KMS](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see [Identifying Symmetric and Asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide* . \n\nAWS KMS supports the following key specs for KMS keys:\n\n- Symmetric key (default)\n\n- `SYMMETRIC_DEFAULT` (AES-256-GCM)\n- Asymmetric RSA key pairs\n\n- `RSA_2048`\n- `RSA_3072`\n- `RSA_4096`\n- Asymmetric NIST-recommended elliptic curve key pairs\n\n- `ECC_NIST_P256` (secp256r1)\n- `ECC_NIST_P384` (secp384r1)\n- `ECC_NIST_P521` (secp521r1)\n- Other asymmetric elliptic curve key pairs\n\n- `ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies.",
|
|
22625
22707
|
"KeyUsage": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is `ENCRYPT_DECRYPT` . This property is required only for asymmetric KMS keys. You can't change the `KeyUsage` value after the KMS key is created.\n\n> If you change the `KeyUsage` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeyUsage` value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. \n\nSelect only one valid value.\n\n- For symmetric KMS keys, omit the property or specify `ENCRYPT_DECRYPT` .\n- For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY` .\n- For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY` .",
|
|
22626
|
-
"MultiRegion": "Creates a multi-Region primary key that you can replicate in other AWS Regions .\n\n> If you change the `MultiRegion` property of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `Multi-Region` value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. \n\nFor a multi-Region key, set to this property to `true` . For a single-Region key, omit this property or set it to `false` . The default value is `false` .\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [
|
|
22708
|
+
"MultiRegion": "Creates a multi-Region primary key that you can replicate in other AWS Regions .\n\n> If you change the `MultiRegion` property of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `Multi-Region` value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. \n\nFor a multi-Region key, set to this property to `true` . For a single-Region key, omit this property or set it to `false` . The default value is `false` .\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [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\nYou can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n\nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.",
|
|
22627
22709
|
"PendingWindowInDays": "Specifies the number of days in the waiting period before AWS KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a KMS key from a CloudFormation stack, AWS KMS schedules the KMS key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of KMS key is `Pending Deletion` or `Pending Replica Deletion` , which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the KMS key.\n\nAWS KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to `PendingReplicaDeletion` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to `PendingDeletion` and the waiting period specified by `PendingWindowInDays` begins. When this waiting period expires, AWS KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nYou cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n\nFor information about the `Pending Deletion` and `Pending Replica Deletion` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
|
|
22628
|
-
"Tags": "Assigns one or more tags to the replica key.\n\n> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [
|
|
22710
|
+
"Tags": "Assigns one or more tags to the replica key.\n\n> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* . \n\nFor information about tags in AWS KMS , see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide* . For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
22629
22711
|
}
|
|
22630
22712
|
},
|
|
22631
22713
|
"AWS::KMS::ReplicaKey": {
|
|
@@ -22634,14 +22716,14 @@
|
|
|
22634
22716
|
"KeyId": "The key ID of the replica key, such as `mrk-1234abcd12ab34cd56ef1234567890ab` .\n\nRelated multi-Region keys have the same key ID. For information about the key IDs of multi-Region keys, see [How multi-Region keys work](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-how-it-works) in the *AWS Key Management Service Developer Guide* .",
|
|
22635
22717
|
"Ref": "`Ref` returns the key ID, such as `mrk-1234abcd12ab34cd56ef1234567890ab` ."
|
|
22636
22718
|
},
|
|
22637
|
-
"description": "The `AWS::KMS::ReplicaKey` resource specifies a multi-Region replica key that is based on a multi-Region primary key.\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [
|
|
22719
|
+
"description": "The `AWS::KMS::ReplicaKey` resource specifies a multi-Region replica key that is based on a multi-Region primary key.\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [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\nA multi-Region *primary key* is a fully functional symmetric or asymmetric KMS key that is also the model for replica keys in other AWS Regions . To create a multi-Region primary key, add an [AWS::KMS::Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html) resource to your CloudFormation stack. Set its `MultiRegion` property to true.\n\nA multi-Region *replica key* is a fully functional symmetric or asymmetric KMS key that has the same key ID and key material as a multi-Region primary key, but is located in a different AWS Region of the same AWS partition. There can be multiple replicas of a primary key, but each must be in a different AWS Region .\n\nA primary key and its replicas have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. These properties are known as *shared properties* . If they change, AWS KMS synchronizes the change to all related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and key state. AWS KMS does not synchronize these properties.",
|
|
22638
22720
|
"properties": {
|
|
22639
22721
|
"Description": "A description of the KMS key.\n\nThe default value is an empty string (no description).\n\nThe description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. AWS Key Management Service does not synchronize this property.",
|
|
22640
22722
|
"Enabled": "Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations.\n\nWhen `Enabled` is `true` , the *key state* of the KMS key is `Enabled` . When `Enabled` is `false` , the key state of the KMS key is `Disabled` . The default value is `true` .\n\nThe actual key state of the replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. Also, while the replica key is being created, its key state is `Creating` . When the process is complete, the key state of the replica key changes to `Enabled` .\n\nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .",
|
|
22641
22723
|
"KeyPolicy": "The key policy that authorizes use of the replica key.\n\nThe key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nThe key policy must conform to the following rules.\n\n- The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n- The key policy size limit is 32 kilobytes (32768 bytes).\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
|
|
22642
22724
|
"PendingWindowInDays": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of replica key is `Pending Deletion` , which prevents it from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the replica key.\n\nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi-Region key.\n\nFor detailed information about deleting multi-Region keys, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
|
|
22643
22725
|
"PrimaryKeyArn": "Specifies the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS partition. You can create only one replica of a given primary key in each AWS Region .\n\n> If you change the `PrimaryKeyArn` value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key. While it is scheduled for deletion, the existing replica key becomes unusable. You can cancel the scheduled deletion of the key outside of CloudFormation.\n> \n> However, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi-Region key. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* \n\nSpecify the key ARN of an existing multi-Region primary key. For example, `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab` .",
|
|
22644
|
-
"Tags": "Assigns one or more tags to the replica key.\n\n> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [
|
|
22726
|
+
"Tags": "Assigns one or more tags to the replica key.\n\n> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* . \n\nTags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.\n\nWhen you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) ."
|
|
22645
22727
|
}
|
|
22646
22728
|
},
|
|
22647
22729
|
"AWS::Kendra::DataSource": {
|
|
@@ -22796,7 +22878,7 @@
|
|
|
22796
22878
|
"ServiceNowConfiguration": "Provides configuration for data sources that connect to ServiceNow instances.",
|
|
22797
22879
|
"SharePointConfiguration": "Provides information necessary to create a data source connector for a Microsoft SharePoint site.",
|
|
22798
22880
|
"WebCrawlerConfiguration": "Provides the configuration information required for Amazon Kendra Web Crawler.",
|
|
22799
|
-
"WorkDocsConfiguration": ""
|
|
22881
|
+
"WorkDocsConfiguration": "Provides the configuration information to connect to WorkDocs as your data source."
|
|
22800
22882
|
}
|
|
22801
22883
|
},
|
|
22802
22884
|
"AWS::Kendra::DataSource.DataSourceToIndexFieldMapping": {
|
|
@@ -22871,11 +22953,11 @@
|
|
|
22871
22953
|
},
|
|
22872
22954
|
"AWS::Kendra::DataSource.ProxyConfiguration": {
|
|
22873
22955
|
"attributes": {},
|
|
22874
|
-
"description": "",
|
|
22956
|
+
"description": "Provides the configuration information for a web proxy to connect to website hosts.",
|
|
22875
22957
|
"properties": {
|
|
22876
|
-
"Credentials": "",
|
|
22877
|
-
"Host": "",
|
|
22878
|
-
"Port": ""
|
|
22958
|
+
"Credentials": "Your secret ARN, which you can create in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)\n\nThe credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.",
|
|
22959
|
+
"Host": "The name of the website host you want to connect to via a web proxy server.\n\nFor example, the host name of https://a.example.com/page1.html is \"a.example.com\".",
|
|
22960
|
+
"Port": "The port number of the website host you want to connect to via a web proxy server.\n\nFor example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS."
|
|
22879
22961
|
}
|
|
22880
22962
|
},
|
|
22881
22963
|
"AWS::Kendra::DataSource.S3DataSourceConfiguration": {
|
|
@@ -23021,7 +23103,7 @@
|
|
|
23021
23103
|
"SslCertificateS3Path": "Information required to find a specific file in an Amazon S3 bucket.",
|
|
23022
23104
|
"Urls": "The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.",
|
|
23023
23105
|
"UseChangeLog": "Set to `TRUE` to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.",
|
|
23024
|
-
"VpcConfiguration": ""
|
|
23106
|
+
"VpcConfiguration": "Provides information for connecting to an Amazon VPC."
|
|
23025
23107
|
}
|
|
23026
23108
|
},
|
|
23027
23109
|
"AWS::Kendra::DataSource.SqlConfiguration": {
|
|
@@ -23049,17 +23131,17 @@
|
|
|
23049
23131
|
},
|
|
23050
23132
|
"AWS::Kendra::DataSource.WebCrawlerConfiguration": {
|
|
23051
23133
|
"attributes": {},
|
|
23052
|
-
"description": "",
|
|
23134
|
+
"description": "Provides the configuration information required for Amazon Kendra Web Crawler.",
|
|
23053
23135
|
"properties": {
|
|
23054
|
-
"AuthenticationConfiguration": "",
|
|
23055
|
-
"CrawlDepth": "",
|
|
23056
|
-
"MaxContentSizePerPageInMegaBytes": "",
|
|
23057
|
-
"MaxLinksPerPage": "",
|
|
23058
|
-
"MaxUrlsPerMinuteCrawlRate": "",
|
|
23059
|
-
"ProxyConfiguration": "",
|
|
23060
|
-
"UrlExclusionPatterns": "",
|
|
23061
|
-
"UrlInclusionPatterns": "",
|
|
23062
|
-
"Urls": "Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.\n\nYou can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.\n\nYou can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.\n\n*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use
|
|
23136
|
+
"AuthenticationConfiguration": "Provides configuration information required to connect to websites using authentication.\n\nYou can connect to websites using basic authentication of user name and password.\n\nYou must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials.",
|
|
23137
|
+
"CrawlDepth": "Specifies the number of levels in a website that you want to crawl.\n\nThe first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.\n\nThe default crawl depth is set to 2.",
|
|
23138
|
+
"MaxContentSizePerPageInMegaBytes": "The maximum size (in MB) of a webpage or attachment to crawl.\n\nFiles larger than this size (in MB) are skipped/not crawled.\n\nThe default maximum size of a webpage or attachment is set to 50 MB.",
|
|
23139
|
+
"MaxLinksPerPage": "The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.\n\nAs a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.\n\nThe default maximum links per page is 100.",
|
|
23140
|
+
"MaxUrlsPerMinuteCrawlRate": "The maximum number of URLs crawled per website host per minute.\n\nA minimum of one URL is required.\n\nThe default maximum number of URLs crawled per website host per minute is 300.",
|
|
23141
|
+
"ProxyConfiguration": "Provides configuration information required to connect to your internal websites via a web proxy.\n\nYou must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.\n\nWeb proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) .",
|
|
23142
|
+
"UrlExclusionPatterns": "The regular expression pattern to exclude certain URLs to crawl.\n\nIf there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.",
|
|
23143
|
+
"UrlInclusionPatterns": "The regular expression pattern to include certain URLs to crawl.\n\nIf there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.",
|
|
23144
|
+
"Urls": "Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.\n\nYou can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.\n\nYou can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.\n\n*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.*"
|
|
23063
23145
|
}
|
|
23064
23146
|
},
|
|
23065
23147
|
"AWS::Kendra::DataSource.WebCrawlerSeedUrlConfiguration": {
|
|
@@ -23074,7 +23156,7 @@
|
|
|
23074
23156
|
"attributes": {},
|
|
23075
23157
|
"description": "Provides the configuration information of the sitemap URLs to crawl.\n\n*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.*",
|
|
23076
23158
|
"properties": {
|
|
23077
|
-
"SiteMaps": ""
|
|
23159
|
+
"SiteMaps": "The list of sitemap URLs of the websites you want to crawl.\n\nThe list can include a maximum of three sitemap URLs."
|
|
23078
23160
|
}
|
|
23079
23161
|
},
|
|
23080
23162
|
"AWS::Kendra::DataSource.WebCrawlerUrls": {
|
|
@@ -23087,14 +23169,14 @@
|
|
|
23087
23169
|
},
|
|
23088
23170
|
"AWS::Kendra::DataSource.WorkDocsConfiguration": {
|
|
23089
23171
|
"attributes": {},
|
|
23090
|
-
"description": "",
|
|
23172
|
+
"description": "Provides the configuration information to connect to Amazon WorkDocs as your data source.\n\nAmazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.",
|
|
23091
23173
|
"properties": {
|
|
23092
|
-
"CrawlComments": "",
|
|
23093
|
-
"ExclusionPatterns": "",
|
|
23094
|
-
"FieldMappings": "",
|
|
23095
|
-
"InclusionPatterns": "",
|
|
23096
|
-
"OrganizationId": "",
|
|
23097
|
-
"UseChangeLog": ""
|
|
23174
|
+
"CrawlComments": "`TRUE` to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.\n\nThe default is set to `FALSE` .",
|
|
23175
|
+
"ExclusionPatterns": "A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.",
|
|
23176
|
+
"FieldMappings": "A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the `UpdateIndex` operation before you map to Amazon WorkDocs fields. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.",
|
|
23177
|
+
"InclusionPatterns": "A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.",
|
|
23178
|
+
"OrganizationId": "The identifier of the directory corresponding to your Amazon WorkDocs site repository.\n\nYou can find the organization ID in the [AWS Directory Service](https://docs.aws.amazon.com/directoryservicev2/) by going to *Active Directory* , then *Directories* . Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.",
|
|
23179
|
+
"UseChangeLog": "`TRUE` to use the change logs to update documents in your index instead of scanning all documents.\n\nIf you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.\n\nThe default is set to `FALSE` ."
|
|
23098
23180
|
}
|
|
23099
23181
|
},
|
|
23100
23182
|
"AWS::Kendra::Faq": {
|
|
@@ -24391,7 +24473,7 @@
|
|
|
24391
24473
|
"attributes": {},
|
|
24392
24474
|
"description": "A structure for the resource.",
|
|
24393
24475
|
"properties": {
|
|
24394
|
-
"DataLocationResource": "
|
|
24476
|
+
"DataLocationResource": "A structure for a data location object where permissions are granted or revoked.",
|
|
24395
24477
|
"DatabaseResource": "A structure for the database object.",
|
|
24396
24478
|
"TableResource": "A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.",
|
|
24397
24479
|
"TableWithColumnsResource": "Currently not supported by AWS CloudFormation ."
|
|
@@ -24404,12 +24486,12 @@
|
|
|
24404
24486
|
"CatalogId": "",
|
|
24405
24487
|
"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.",
|
|
24406
24488
|
"Name": "The name of the table.",
|
|
24407
|
-
"TableWildcard": ""
|
|
24489
|
+
"TableWildcard": "An empty object representing all tables under a database. If this field is specified instead of the `Name` field, all tables under `DatabaseName` will have permission changes applied."
|
|
24408
24490
|
}
|
|
24409
24491
|
},
|
|
24410
24492
|
"AWS::LakeFormation::Permissions.TableWildcard": {
|
|
24411
24493
|
"attributes": {},
|
|
24412
|
-
"description": "",
|
|
24494
|
+
"description": "A wildcard object representing every table under a database.",
|
|
24413
24495
|
"properties": {}
|
|
24414
24496
|
},
|
|
24415
24497
|
"AWS::LakeFormation::Permissions.TableWithColumnsResource": {
|
|
@@ -24545,7 +24627,7 @@
|
|
|
24545
24627
|
"FilterCriteria": "(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) .",
|
|
24546
24628
|
"FunctionName": "The name of the Lambda function.\n\n**Name formats** - *Function name* - `MyFunction` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Version or Alias ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD` .\n- *Partial ARN* - `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.",
|
|
24547
24629
|
"FunctionResponseTypes": "(Streams and SQS) A list of current response type enums applied to the event source mapping.\n\nValid Values: `ReportBatchItemFailures`",
|
|
24548
|
-
"MaximumBatchingWindowInSeconds": "
|
|
24630
|
+
"MaximumBatchingWindowInSeconds": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n\n*Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0\n\n*Default ( Amazon MSK , Kafka, Amazon MQ event sources)* : 500 ms",
|
|
24549
24631
|
"MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.",
|
|
24550
24632
|
"MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.",
|
|
24551
24633
|
"ParallelizationFactor": "(Streams only) The number of batches to process concurrently from each shard. The default value is 1.",
|
|
@@ -25431,6 +25513,101 @@
|
|
|
25431
25513
|
"GetObject": "Specifies the anonymous access to all objects in a bucket.\n\nThe following options can be specified:\n\n- `public` - Sets all objects in the bucket to public (read-only), making them readable by everyone on the internet.\n\nIf the `GetObject` value is set to `public` , then all objects in the bucket default to public regardless of the `allowPublicOverrides` value.\n- `private` - Sets all objects in the bucket to private, making them readable only by you and anyone that you grant access to.\n\nIf the `GetObject` value is set to `private` , and the `allowPublicOverrides` value is set to `true` , then all objects in the bucket default to private unless they are configured with a `public-read` ACL. Individual objects with a `public-read` ACL are readable by everyone on the internet."
|
|
25432
25514
|
}
|
|
25433
25515
|
},
|
|
25516
|
+
"AWS::Lightsail::Certificate": {
|
|
25517
|
+
"attributes": {
|
|
25518
|
+
"CertificateArn": "The Amazon Resource Name (ARN) of the certificate.",
|
|
25519
|
+
"Ref": "",
|
|
25520
|
+
"Status": "The validation status of the certificate."
|
|
25521
|
+
},
|
|
25522
|
+
"description": "The `AWS::Lightsail::Certificate` resource specifies an SSL/TLS certificate that you can use with a content delivery network (CDN) distribution and a container service.\n\n> For information about certificates that you can use with a load balancer, see [AWS::Lightsail::LoadBalancerTlsCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html) .",
|
|
25523
|
+
"properties": {
|
|
25524
|
+
"CertificateName": "The name of the certificate.",
|
|
25525
|
+
"DomainName": "The domain name of the certificate.",
|
|
25526
|
+
"SubjectAlternativeNames": "An array of strings that specify the alternate domains (such as `example.org` ) and subdomains (such as `blog.example.com` ) of the certificate.",
|
|
25527
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .\n\n> The `Value` of `Tags` is optional for Lightsail resources."
|
|
25528
|
+
}
|
|
25529
|
+
},
|
|
25530
|
+
"AWS::Lightsail::Container": {
|
|
25531
|
+
"attributes": {
|
|
25532
|
+
"ContainerArn": "The Amazon Resource Name (ARN) of the container.",
|
|
25533
|
+
"Ref": "",
|
|
25534
|
+
"Url": "The publicly accessible URL of the container service.\n\nIf no public endpoint is specified in the current deployment, this URL returns a 404 response."
|
|
25535
|
+
},
|
|
25536
|
+
"description": "The `AWS::Lightsail::Container` resource specifies a container service.\n\nA Lightsail container service is a compute resource to which you can deploy containers.",
|
|
25537
|
+
"properties": {
|
|
25538
|
+
"ContainerServiceDeployment": "An object that describes the current container deployment of the container service.",
|
|
25539
|
+
"IsDisabled": "A Boolean value indicating whether the container service is disabled.",
|
|
25540
|
+
"Power": "The power specification of the container service.\n\nThe power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.",
|
|
25541
|
+
"PublicDomainNames": "The public domain name of the container service, such as `example.com` and `www.example.com` .\n\nYou can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container that is configured as the public endpoint of your container service.\n\nIf you don't specify public domain names, then you can use the default domain of the container service.\n\n> You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the [AWS::Lightsail::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html) resource to create a certificate for the public domain names that you want to use with your container service.",
|
|
25542
|
+
"Scale": "The scale specification of the container service.\n\nThe scale specifies the allocated compute nodes of the container service.",
|
|
25543
|
+
"ServiceName": "The name of the container service.",
|
|
25544
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .\n\n> The `Value` of `Tags` is optional for Lightsail resources."
|
|
25545
|
+
}
|
|
25546
|
+
},
|
|
25547
|
+
"AWS::Lightsail::Container.Container": {
|
|
25548
|
+
"attributes": {},
|
|
25549
|
+
"description": "`Container` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property. It describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.",
|
|
25550
|
+
"properties": {
|
|
25551
|
+
"Command": "The launch command for the container.",
|
|
25552
|
+
"ContainerName": "The name of the container.",
|
|
25553
|
+
"Environment": "The environment variables of the container.",
|
|
25554
|
+
"Image": "The name of the image used for the container.\n\nContainer images that are sourced from (registered and stored on) your container service start with a colon ( `:` ). For example, if your container service name is `container-service-1` , the container image label is `mystaticsite` , and you want to use the third version ( `3` ) of the registered container image, then you should specify `:container-service-1.mystaticsite.3` . To use the latest version of a container image, specify `latest` instead of a version number (for example, `:container-service-1.mystaticsite.latest` ). Your container service will automatically use the highest numbered version of the registered container image.\n\nContainer images that are sourced from a public registry like Docker Hub don’t start with a colon. For example, `nginx:latest` or `nginx` .",
|
|
25555
|
+
"Ports": "An object that describes the open firewall ports and protocols of the container."
|
|
25556
|
+
}
|
|
25557
|
+
},
|
|
25558
|
+
"AWS::Lightsail::Container.ContainerServiceDeployment": {
|
|
25559
|
+
"attributes": {},
|
|
25560
|
+
"description": "`ContainerServiceDeployment` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) resource. It describes a container deployment configuration of a container service.\n\nA deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.",
|
|
25561
|
+
"properties": {
|
|
25562
|
+
"Containers": "An object that describes the configuration for the containers of the deployment.",
|
|
25563
|
+
"PublicEndpoint": "An object that describes the endpoint of the deployment."
|
|
25564
|
+
}
|
|
25565
|
+
},
|
|
25566
|
+
"AWS::Lightsail::Container.EnvironmentVariable": {
|
|
25567
|
+
"attributes": {},
|
|
25568
|
+
"description": "`EnvironmentVariable` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) property. It describes the environment variables of a container on a container service which are key-value parameters that provide dynamic configuration of the application or script run by the container.",
|
|
25569
|
+
"properties": {
|
|
25570
|
+
"Value": "The environment variable value.",
|
|
25571
|
+
"Variable": "The environment variable key."
|
|
25572
|
+
}
|
|
25573
|
+
},
|
|
25574
|
+
"AWS::Lightsail::Container.HealthCheckConfig": {
|
|
25575
|
+
"attributes": {},
|
|
25576
|
+
"description": "`HealthCheckConfig` is a property of the [PublicEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html) property. It describes the healthcheck configuration of a container deployment on a container service.",
|
|
25577
|
+
"properties": {
|
|
25578
|
+
"HealthyThreshold": "The number of consecutive health check successes required before moving the container to the `Healthy` state. The default value is `2` .",
|
|
25579
|
+
"IntervalSeconds": "The approximate interval, in seconds, between health checks of an individual container. You can specify between `5` and `300` seconds. The default value is `5` .",
|
|
25580
|
+
"Path": "The path on the container on which to perform the health check. The default value is `/` .",
|
|
25581
|
+
"SuccessCodes": "The HTTP codes to use when checking for a successful response from a container. You can specify values between `200` and `499` . You can specify multiple values (for example, `200,202` ) or a range of values (for example, `200-299` ).",
|
|
25582
|
+
"TimeoutSeconds": "The amount of time, in seconds, during which no response means a failed health check. You can specify between `2` and `60` seconds. The default value is `2` .",
|
|
25583
|
+
"UnhealthyThreshold": "The number of consecutive health check failures required before moving the container to the `Unhealthy` state. The default value is `2` ."
|
|
25584
|
+
}
|
|
25585
|
+
},
|
|
25586
|
+
"AWS::Lightsail::Container.PortInfo": {
|
|
25587
|
+
"attributes": {},
|
|
25588
|
+
"description": "`PortInfo` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) property. It describes the ports to open and the protocols to use for a container on a Amazon Lightsail container service.",
|
|
25589
|
+
"properties": {
|
|
25590
|
+
"Port": "The open firewall ports of the container.",
|
|
25591
|
+
"Protocol": "The protocol name for the open ports.\n\n*Allowed values* : `HTTP` | `HTTPS` | `TCP` | `UDP`"
|
|
25592
|
+
}
|
|
25593
|
+
},
|
|
25594
|
+
"AWS::Lightsail::Container.PublicDomainName": {
|
|
25595
|
+
"attributes": {},
|
|
25596
|
+
"description": "`PublicDomainName` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) resource. It describes the public domain names to use with a container service, such as `example.com` and `www.example.com` . It also describes the certificates to use with a container service.",
|
|
25597
|
+
"properties": {
|
|
25598
|
+
"CertificateName": "The name of the certificate for the public domains.",
|
|
25599
|
+
"DomainNames": "The public domain names to use with the container service."
|
|
25600
|
+
}
|
|
25601
|
+
},
|
|
25602
|
+
"AWS::Lightsail::Container.PublicEndpoint": {
|
|
25603
|
+
"attributes": {},
|
|
25604
|
+
"description": "`PublicEndpoint` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property. It describes describes the settings of the public endpoint of a container on a container service.",
|
|
25605
|
+
"properties": {
|
|
25606
|
+
"ContainerName": "The name of the container entry of the deployment that the endpoint configuration applies to.",
|
|
25607
|
+
"ContainerPort": "The port of the specified container to which traffic is forwarded to.",
|
|
25608
|
+
"HealthCheckConfig": "An object that describes the health check configuration of the container."
|
|
25609
|
+
}
|
|
25610
|
+
},
|
|
25434
25611
|
"AWS::Lightsail::Database": {
|
|
25435
25612
|
"attributes": {
|
|
25436
25613
|
"DatabaseArn": "The Amazon Resource Name (ARN) of the database (for example, `arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE` ).",
|
|
@@ -25507,6 +25684,89 @@
|
|
|
25507
25684
|
"SnapshotTimeOfDay": "The daily time when an automatic snapshot will be created.\n\nConstraints:\n\n- Must be in `HH:00` format, and in an hourly increment.\n- Specified in Coordinated Universal Time (UTC).\n- The snapshot will be automatically created between the time specified and up to 45 minutes after."
|
|
25508
25685
|
}
|
|
25509
25686
|
},
|
|
25687
|
+
"AWS::Lightsail::Distribution": {
|
|
25688
|
+
"attributes": {
|
|
25689
|
+
"AbleToUpdateBundle": "Indicates whether you can update the distribution’s current bundle to another bundle.",
|
|
25690
|
+
"DistributionArn": "The Amazon Resource Name (ARN) of the distribution.",
|
|
25691
|
+
"Ref": "",
|
|
25692
|
+
"Status": "The status of the distribution."
|
|
25693
|
+
},
|
|
25694
|
+
"description": "The `AWS::Lightsail::Distribution` resource specifies a content delivery network (CDN) distribution. You can create distributions only in the `us-east-1` AWS Region.\n\nA distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.",
|
|
25695
|
+
"properties": {
|
|
25696
|
+
"BundleId": "The ID of the bundle applied to the distribution.",
|
|
25697
|
+
"CacheBehaviorSettings": "An object that describes the cache behavior settings of the distribution.",
|
|
25698
|
+
"CacheBehaviors": "An array of objects that describe the per-path cache behavior of the distribution.",
|
|
25699
|
+
"CertificateName": "The name of the SSL/TLS certificate attached to the distribution.",
|
|
25700
|
+
"DefaultCacheBehavior": "An object that describes the default cache behavior of the distribution.",
|
|
25701
|
+
"DistributionName": "The name of the distribution",
|
|
25702
|
+
"IpAddressType": "The IP address type of the distribution.\n\nThe possible values are `ipv4` for IPv4 only, and `dualstack` for IPv4 and IPv6.",
|
|
25703
|
+
"IsEnabled": "A Boolean value indicating whether the distribution is enabled.",
|
|
25704
|
+
"Origin": "An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.\n\nThe distribution pulls, caches, and serves content from the origin.",
|
|
25705
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .\n\n> The `Value` of `Tags` is optional for Lightsail resources."
|
|
25706
|
+
}
|
|
25707
|
+
},
|
|
25708
|
+
"AWS::Lightsail::Distribution.CacheBehavior": {
|
|
25709
|
+
"attributes": {},
|
|
25710
|
+
"description": "`CacheBehavior` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.",
|
|
25711
|
+
"properties": {
|
|
25712
|
+
"Behavior": "The cache behavior of the distribution.\n\nThe following cache behaviors can be specified:\n\n- *`cache`* - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.\n- *`dont-cache`* - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serves only the content that is specified in the distribution’s `CacheBehaviorPerPath` parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users."
|
|
25713
|
+
}
|
|
25714
|
+
},
|
|
25715
|
+
"AWS::Lightsail::Distribution.CacheBehaviorPerPath": {
|
|
25716
|
+
"attributes": {},
|
|
25717
|
+
"description": "`CacheBehaviorPerPath` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.\n\nUse a per-path cache behavior to override the default cache behavior of a distribution, or to add an exception to it. For example, if you set the `CacheBehavior` to `cache` , you can use a per-path cache behavior to specify a directory, file, or file type that your distribution will cache. If you don’t want your distribution to cache a specified directory, file, or file type, set the per-path cache behavior to `dont-cache` .",
|
|
25718
|
+
"properties": {
|
|
25719
|
+
"Behavior": "The cache behavior for the specified path.\n\nYou can specify one of the following per-path cache behaviors:\n\n- *`cache`* - This behavior caches the specified path.\n- *`dont-cache`* - This behavior doesn't cache the specified path.",
|
|
25720
|
+
"Path": "The path to a directory or file to cache, or not cache. Use an asterisk symbol to specify wildcard directories ( `path/to/assets/*` ), and file types ( `*.html` , `*jpg` , `*js` ). Directories and file paths are case-sensitive.\n\nExamples:\n\n- Specify the following to cache all files in the document root of an Apache web server running on a instance.\n\n`var/www/html/`\n- Specify the following file to cache only the index page in the document root of an Apache web server.\n\n`var/www/html/index.html`\n- Specify the following to cache only the .html files in the document root of an Apache web server.\n\n`var/www/html/*.html`\n- Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.\n\n`var/www/html/images/*.jpg`\n\n`var/www/html/images/*.png`\n\n`var/www/html/images/*.gif`\n\nSpecify the following to cache all files in the images subdirectory of the document root of an Apache web server.\n\n`var/www/html/images/`"
|
|
25721
|
+
}
|
|
25722
|
+
},
|
|
25723
|
+
"AWS::Lightsail::Distribution.CacheSettings": {
|
|
25724
|
+
"attributes": {},
|
|
25725
|
+
"description": "`CacheSettings` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.\n\nThese settings apply only to your distribution’s `CacheBehaviors` that have a `Behavior` of `cache` . This includes the `DefaultCacheBehavior` .",
|
|
25726
|
+
"properties": {
|
|
25727
|
+
"AllowedHTTPMethods": "The HTTP methods that are processed and forwarded to the distribution's origin.\n\nYou can specify the following options:\n\n- `GET,HEAD` - The distribution forwards the `GET` and `HEAD` methods.\n- `GET,HEAD,OPTIONS` - The distribution forwards the `GET` , `HEAD` , and `OPTIONS` methods.\n- `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` - The distribution forwards the `GET` , `HEAD` , `OPTIONS` , `PUT` , `PATCH` , `POST` , and `DELETE` methods.\n\nIf you specify `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` , you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.",
|
|
25728
|
+
"CachedHTTPMethods": "The HTTP method responses that are cached by your distribution.\n\nYou can specify the following options:\n\n- `GET,HEAD` - The distribution caches responses to the `GET` and `HEAD` methods.\n- `GET,HEAD,OPTIONS` - The distribution caches responses to the `GET` , `HEAD` , and `OPTIONS` methods.",
|
|
25729
|
+
"DefaultTTL": "The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.\n\n> The value specified applies only when the origin does not add HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.",
|
|
25730
|
+
"ForwardedCookies": "An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.",
|
|
25731
|
+
"ForwardedHeaders": "An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.",
|
|
25732
|
+
"ForwardedQueryStrings": "An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.",
|
|
25733
|
+
"MaximumTTL": "The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.\n\nThe value specified applies only when the origin adds HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.",
|
|
25734
|
+
"MinimumTTL": "The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.\n\nA value of `0` must be specified for `minimumTTL` if the distribution is configured to forward all headers to the origin."
|
|
25735
|
+
}
|
|
25736
|
+
},
|
|
25737
|
+
"AWS::Lightsail::Distribution.CookieObject": {
|
|
25738
|
+
"attributes": {},
|
|
25739
|
+
"description": "`CookieObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.\n\nFor the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.",
|
|
25740
|
+
"properties": {
|
|
25741
|
+
"CookiesAllowList": "The specific cookies to forward to your distribution's origin.",
|
|
25742
|
+
"Option": "Specifies which cookies to forward to the distribution's origin for a cache behavior.\n\nUse one of the following configurations for your distribution:\n\n- *`all`* - Forwards all cookies to your origin.\n- *`none`* - Doesn’t forward cookies to your origin.\n- *`allow-list`* - Forwards only the cookies that you specify using the `CookiesAllowList` parameter."
|
|
25743
|
+
}
|
|
25744
|
+
},
|
|
25745
|
+
"AWS::Lightsail::Distribution.HeaderObject": {
|
|
25746
|
+
"attributes": {},
|
|
25747
|
+
"description": "`HeaderObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the request headers used by your distribution, which caches your content based on the request headers.\n\nFor the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose that viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex. Also, suppose that you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.",
|
|
25748
|
+
"properties": {
|
|
25749
|
+
"HeadersAllowList": "The specific headers to forward to your distribution's origin.",
|
|
25750
|
+
"Option": "The headers that you want your distribution to forward to your origin. Your distribution caches your content based on these headers.\n\nUse one of the following configurations for your distribution:\n\n- *`all`* - Forwards all headers to your origin..\n- *`none`* - Forwards only the default headers.\n- *`allow-list`* - Forwards only the headers that you specify using the `HeadersAllowList` parameter."
|
|
25751
|
+
}
|
|
25752
|
+
},
|
|
25753
|
+
"AWS::Lightsail::Distribution.InputOrigin": {
|
|
25754
|
+
"attributes": {},
|
|
25755
|
+
"description": "`InputOrigin` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.\n\nAn origin can be a instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers through a worldwide network of edge servers.",
|
|
25756
|
+
"properties": {
|
|
25757
|
+
"Name": "The name of the origin resource.",
|
|
25758
|
+
"ProtocolPolicy": "The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.",
|
|
25759
|
+
"RegionName": "The AWS Region name of the origin resource."
|
|
25760
|
+
}
|
|
25761
|
+
},
|
|
25762
|
+
"AWS::Lightsail::Distribution.QueryStringObject": {
|
|
25763
|
+
"attributes": {},
|
|
25764
|
+
"description": "`QueryStringObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.\n\nFor the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.",
|
|
25765
|
+
"properties": {
|
|
25766
|
+
"Option": "Indicates whether the distribution forwards and caches based on query strings.",
|
|
25767
|
+
"QueryStringsAllowList": "The specific query strings that the distribution forwards to the origin.\n\nYour distribution caches content based on the specified query strings.\n\nIf the `option` parameter is true, then your distribution forwards all query strings, regardless of what you specify using the `QueryStringsAllowList` parameter."
|
|
25768
|
+
}
|
|
25769
|
+
},
|
|
25510
25770
|
"AWS::Lightsail::Instance": {
|
|
25511
25771
|
"attributes": {
|
|
25512
25772
|
"Hardware.CpuCount": "The number of vCPUs the instance has.",
|
|
@@ -26080,7 +26340,7 @@
|
|
|
26080
26340
|
"attributes": {
|
|
26081
26341
|
"Ref": "`Ref` returns the Amazon MSK cluster ARN. For example:\n\n`REF MyTestCluster`\n\nFor the Amazon MSK cluster `MyTestCluster` , Ref returns the ARN of the cluster."
|
|
26082
26342
|
},
|
|
26083
|
-
"description": "The `AWS::MSK::Cluster` resource creates an Amazon MSK cluster. For more information, see [What Is Amazon MSK?](https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html) in the *Amazon MSK Developer Guide* .",
|
|
26343
|
+
"description": "The `AWS::MSK::Cluster` resource creates an Amazon MSK cluster . For more information, see [What Is Amazon MSK?](https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html) in the *Amazon MSK Developer Guide* .",
|
|
26084
26344
|
"properties": {
|
|
26085
26345
|
"BrokerNodeGroupInfo": "The setup to be used for brokers in the cluster.",
|
|
26086
26346
|
"ClientAuthentication": "Includes information related to client authentication.",
|
|
@@ -26088,8 +26348,8 @@
|
|
|
26088
26348
|
"ConfigurationInfo": "The Amazon MSK configuration to use for the cluster.",
|
|
26089
26349
|
"EncryptionInfo": "Includes all encryption-related information.",
|
|
26090
26350
|
"EnhancedMonitoring": "Specifies the level of monitoring for the MSK cluster. The possible values are `DEFAULT` , `PER_BROKER` , and `PER_TOPIC_PER_BROKER` .",
|
|
26091
|
-
"KafkaVersion": "The version of Apache Kafka.
|
|
26092
|
-
"LoggingInfo": "You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.",
|
|
26351
|
+
"KafkaVersion": "The version of Apache Kafka. For more information, see [Supported Apache Kafka versions](https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html) in the Amazon MSK Developer Guide.",
|
|
26352
|
+
"LoggingInfo": "You can configure your Amazon MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.",
|
|
26093
26353
|
"NumberOfBrokerNodes": "The number of broker nodes you want in the Amazon MSK cluster. You can submit an update to increase the number of broker nodes in a cluster.",
|
|
26094
26354
|
"OpenMonitoring": "The settings for open monitoring.",
|
|
26095
26355
|
"Tags": "A map of key:value pairs to apply to this resource. Both key and value are of type String."
|
|
@@ -26097,11 +26357,11 @@
|
|
|
26097
26357
|
},
|
|
26098
26358
|
"AWS::MSK::Cluster.BrokerLogs": {
|
|
26099
26359
|
"attributes": {},
|
|
26100
|
-
"description": "You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.",
|
|
26360
|
+
"description": "You can configure your Amazon MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.",
|
|
26101
26361
|
"properties": {
|
|
26102
26362
|
"CloudWatchLogs": "Details of the CloudWatch Logs destination for broker logs.",
|
|
26103
26363
|
"Firehose": "Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.",
|
|
26104
|
-
"S3": "Details of the Amazon
|
|
26364
|
+
"S3": "Details of the Amazon MSK destination for broker logs."
|
|
26105
26365
|
}
|
|
26106
26366
|
},
|
|
26107
26367
|
"AWS::MSK::Cluster.BrokerNodeGroupInfo": {
|
|
@@ -26130,7 +26390,7 @@
|
|
|
26130
26390
|
"description": "Details of the CloudWatch Logs destination for broker logs.",
|
|
26131
26391
|
"properties": {
|
|
26132
26392
|
"Enabled": "Specifies whether broker logs get sent to the specified CloudWatch Logs destination.",
|
|
26133
|
-
"LogGroup": "The CloudWatch
|
|
26393
|
+
"LogGroup": "The CloudWatch Logs group that is the destination for broker logs."
|
|
26134
26394
|
}
|
|
26135
26395
|
},
|
|
26136
26396
|
"AWS::MSK::Cluster.ConfigurationInfo": {
|
|
@@ -26166,8 +26426,8 @@
|
|
|
26166
26426
|
"attributes": {},
|
|
26167
26427
|
"description": "The settings for encrypting data in transit.",
|
|
26168
26428
|
"properties": {
|
|
26169
|
-
"ClientBroker": "Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.\n\n- `TLS` means that client-broker communication is enabled with TLS only.\n- `TLS_PLAINTEXT` means that client-broker communication is enabled for both TLS-encrypted, as well as
|
|
26170
|
-
"InCluster": "When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in
|
|
26429
|
+
"ClientBroker": "Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.\n\n- `TLS` means that client-broker communication is enabled with TLS only.\n- `TLS_PLAINTEXT` means that client-broker communication is enabled for both TLS-encrypted, as well as plain text data.\n- `PLAINTEXT` means that client-broker communication is enabled in plain text only.\n\nThe default value is `TLS` .",
|
|
26430
|
+
"InCluster": "When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plain text. The default value is true."
|
|
26171
26431
|
}
|
|
26172
26432
|
},
|
|
26173
26433
|
"AWS::MSK::Cluster.EncryptionInfo": {
|
|
@@ -26202,9 +26462,9 @@
|
|
|
26202
26462
|
},
|
|
26203
26463
|
"AWS::MSK::Cluster.LoggingInfo": {
|
|
26204
26464
|
"attributes": {},
|
|
26205
|
-
"description": "You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.",
|
|
26465
|
+
"description": "You can configure your Amazon MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.",
|
|
26206
26466
|
"properties": {
|
|
26207
|
-
"BrokerLogs": "You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations."
|
|
26467
|
+
"BrokerLogs": "You can configure your Amazon MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations."
|
|
26208
26468
|
}
|
|
26209
26469
|
},
|
|
26210
26470
|
"AWS::MSK::Cluster.NodeExporter": {
|
|
@@ -26233,7 +26493,7 @@
|
|
|
26233
26493
|
"attributes": {},
|
|
26234
26494
|
"description": "Specifies whether the cluster's brokers are accessible from the internet. Public access is off by default.",
|
|
26235
26495
|
"properties": {
|
|
26236
|
-
"Type": "Set to DISABLED to turn off public access or to SERVICE_PROVIDED_EIPS to turn it on. Public access if off by default."
|
|
26496
|
+
"Type": "Set to `DISABLED` to turn off public access or to `SERVICE_PROVIDED_EIPS` to turn it on. Public access if off by default."
|
|
26237
26497
|
}
|
|
26238
26498
|
},
|
|
26239
26499
|
"AWS::MSK::Cluster.S3": {
|
|
@@ -29630,13 +29890,13 @@
|
|
|
29630
29890
|
},
|
|
29631
29891
|
"AWS::OpenSearchService::Domain": {
|
|
29632
29892
|
"attributes": {
|
|
29633
|
-
"Arn": "The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-1ab2cdefghij` .
|
|
29893
|
+
"Arn": "The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-1ab2cdefghij` .",
|
|
29634
29894
|
"DomainArn": "",
|
|
29635
29895
|
"DomainEndpoint": "The domain-specific endpoint used for requests to the OpenSearch APIs, such as `search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .",
|
|
29636
|
-
"Id": "",
|
|
29896
|
+
"Id": "The resource ID. For example, `123456789012/my-domain` .",
|
|
29637
29897
|
"Ref": "When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name, such as `mystack-abc1d2efg3h4.` For more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
29638
29898
|
},
|
|
29639
|
-
"description": "The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) domain.\n\n> The `AWS::OpenSearchService::Domain` resource replaces the legacy [AWS::Elasticsearch::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html) resource. While the Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch engines. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see [Remarks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-
|
|
29899
|
+
"description": "The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) domain.\n\n> The `AWS::OpenSearchService::Domain` resource replaces the legacy [AWS::Elasticsearch::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html) resource. While the Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch engines. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see [Remarks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks) .",
|
|
29640
29900
|
"properties": {
|
|
29641
29901
|
"AccessPolicies": "An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. For more information, see [Configuring access policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ac.html#ac-creating) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
29642
29902
|
"AdvancedOptions": "Additional options to specify for the OpenSearch Service domain. For more information, see [Advanced cluster parameters](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
@@ -31368,7 +31628,7 @@
|
|
|
31368
31628
|
"LastUpdatedTime": "The time this dataset version was last updated.",
|
|
31369
31629
|
"OutputColumns": ""
|
|
31370
31630
|
},
|
|
31371
|
-
"description": "Creates a dataset.",
|
|
31631
|
+
"description": "Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.",
|
|
31372
31632
|
"properties": {
|
|
31373
31633
|
"AwsAccountId": "The AWS account ID.",
|
|
31374
31634
|
"ColumnGroups": "Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.",
|
|
@@ -32077,7 +32337,7 @@
|
|
|
32077
32337
|
"ReadEndpoint.Address": "The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com`",
|
|
32078
32338
|
"Ref": "`Ref` returns the name of the DB cluster."
|
|
32079
32339
|
},
|
|
32080
|
-
"description": "The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster. For more information, see [Managing an Amazon Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html) in the *Amazon Aurora User Guide* .\n\n> You can only create this resource in AWS Regions where Amazon Aurora is supported. \n\n*Updating DB clusters*\n\nWhen properties labeled \" *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) \" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.\n\n> We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:\n> \n> - Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.\n> - Create a snapshot of the DB cluster. For more information about creating DB snapshots, see [Creating a DB Cluster Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) .\n> - If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the `SnapshotIdentifier` property with the ID of the DB cluster snapshot that you want to use.\n> \n> After you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted.\n> - Update the stack. \n\nCurrently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: `PreferredBackupWindow` , `PreferredMaintenanceWindow` , and `Port` . This limitation doesn't apply to provisioned DB clusters.\n\nFor more information about updating other properties of this resource, see `[ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n*Deleting DB clusters*\n\nThe default `DeletionPolicy` for `AWS::RDS::DBCluster` resources is `Snapshot` . For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .",
|
|
32340
|
+
"description": "The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster. For more information, see [Managing an Amazon Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html) in the *Amazon Aurora User Guide* .\n\n> You can only create this resource in AWS Regions where Amazon Aurora is supported. \n\nThis topic covers the resource for Amazon Aurora DB clusters. For the documentation on the resource for Amazon RDS DB instances, see [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html) .\n\n*Updating DB clusters*\n\nWhen properties labeled \" *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) \" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.\n\n> We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:\n> \n> - Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.\n> - Create a snapshot of the DB cluster. For more information about creating DB snapshots, see [Creating a DB Cluster Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) .\n> - If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the `SnapshotIdentifier` property with the ID of the DB cluster snapshot that you want to use.\n> \n> After you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted.\n> - Update the stack. \n\nCurrently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: `PreferredBackupWindow` , `PreferredMaintenanceWindow` , and `Port` . This limitation doesn't apply to provisioned DB clusters.\n\nFor more information about updating other properties of this resource, see `[ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n*Deleting DB clusters*\n\nThe default `DeletionPolicy` for `AWS::RDS::DBCluster` resources is `Snapshot` . For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .",
|
|
32081
32341
|
"properties": {
|
|
32082
32342
|
"AssociatedRoles": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.",
|
|
32083
32343
|
"AvailabilityZones": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide* .",
|
|
@@ -32099,7 +32359,7 @@
|
|
|
32099
32359
|
"KmsKeyId": "The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` . If you enable the `StorageEncrypted` property but don't specify this property, the default master key is used. If you specify this property, you must set the `StorageEncrypted` property to `true` .\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used.",
|
|
32100
32360
|
"MasterUserPassword": "The master password for the DB instance.\n\n> If you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot.",
|
|
32101
32361
|
"MasterUsername": "The name of the master user for the DB cluster.\n\n> If you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot.",
|
|
32102
|
-
"Port": "The port number on which the DB instances in the DB cluster accept connections.\n\nDefault:\n\n- When `EngineMode` is `provisioned` , `3306` (for both Aurora MySQL and Aurora PostgreSQL)\n- When `EngineMode` is `serverless` :\n\n- `3306` when `Engine` is `aurora` or `aurora-mysql`\n- `5432` when `Engine` is `aurora-postgresql`",
|
|
32362
|
+
"Port": "The port number on which the DB instances in the DB cluster accept connections.\n\nDefault:\n\n- When `EngineMode` is `provisioned` , `3306` (for both Aurora MySQL and Aurora PostgreSQL)\n- When `EngineMode` is `serverless` :\n\n- `3306` when `Engine` is `aurora` or `aurora-mysql`\n- `5432` when `Engine` is `aurora-postgresql`\n\n> The `No interruption` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.",
|
|
32103
32363
|
"PreferredBackupWindow": "The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.",
|
|
32104
32364
|
"PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n\nFormat: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*\n\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\n\nConstraints: Minimum 30-minute window.",
|
|
32105
32365
|
"ReplicationSourceIdentifier": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.",
|
|
@@ -32150,7 +32410,7 @@
|
|
|
32150
32410
|
"Endpoint.Port": "The port number on which the database accepts connections. For example: `3306`",
|
|
32151
32411
|
"Ref": "`Ref` returns the DB instance name."
|
|
32152
32412
|
},
|
|
32153
|
-
"description": "The `AWS::RDS::DBInstance` resource creates an Amazon RDS DB instance.\n\nIf you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n\n> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) . \n\n*Updating DB instances*\n\nWhen properties labeled \" *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) \" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n\n> We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:\n> \n> - Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n> - Create a snapshot of the DB instance. For more information about creating DB snapshots, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) .\n> - If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use.\n> \n> After you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.\n> - Update the stack. \n\nFor more information about updating other properties of this resource, see `[ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n*Deleting DB instances*\n\nFor DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the `DBClusterIdentifier` property:\n\n- For `AWS::RDS::DBInstance` resources that don't specify the `DBClusterIdentifier` property, AWS CloudFormation saves a snapshot of the DB instance.\n- For `AWS::RDS::DBInstance` resources that do specify the `DBClusterIdentifier` property, AWS CloudFormation deletes the DB instance.\n\nFor more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .",
|
|
32413
|
+
"description": "The `AWS::RDS::DBInstance` resource creates an Amazon RDS DB instance.\n\nIf you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n\n> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) . \n\nThis topic covers the resource for Amazon RDS DB instances. For the documentation on the resource for Amazon Aurora DB clusters, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html) .\n\n*Updating DB instances*\n\nWhen properties labeled \" *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) \" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n\n> We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:\n> \n> - Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n> - Create a snapshot of the DB instance. For more information about creating DB snapshots, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) .\n> - If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use.\n> \n> After you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.\n> - Update the stack. \n\nFor more information about updating other properties of this resource, see `[ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n*Deleting DB instances*\n\nFor DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the `DBClusterIdentifier` property:\n\n- For `AWS::RDS::DBInstance` resources that don't specify the `DBClusterIdentifier` property, AWS CloudFormation saves a snapshot of the DB instance.\n- For `AWS::RDS::DBInstance` resources that do specify the `DBClusterIdentifier` property, AWS CloudFormation deletes the DB instance.\n\nFor more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .",
|
|
32154
32414
|
"properties": {
|
|
32155
32415
|
"AllocatedStorage": "The amount of storage (in gigabytes) to be initially allocated for the database instance.\n\n> If any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the `Iops` value (in 1,000 IOPS increments), then you must also increase the `AllocatedStorage` value (in 100-GiB increments). \n\n*Amazon Aurora*\n\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n\n*MySQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*MariaDB*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*PostgreSQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*Oracle*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 10 to 3072.\n\n*SQL Server*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Provisioned IOPS storage (io1):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Magnetic storage (standard):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 1024.\n- Web and Express editions: Must be an integer from 20 to 1024.",
|
|
32156
32416
|
"AllowMajorVersionUpgrade": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n\nConstraints: Major version upgrades must be allowed when specifying a value for the `EngineVersion` parameter that is a different major version than the DB instance's current version.",
|
|
@@ -32180,7 +32440,7 @@
|
|
|
32180
32440
|
"EngineVersion": "The version number of the database engine to use.\n\nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action.\n\nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n\n*Amazon Aurora*\n\nNot applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n\n*MariaDB*\n\nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Microsoft SQL Server*\n\nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*\n\n*MySQL*\n\nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Oracle*\n\nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*\n\n*PostgreSQL*\n\nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*",
|
|
32181
32441
|
"Iops": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.\n\nIf you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide* .\n\n> If you specify `io1` for the `StorageType` property, then you must also specify the `Iops` property.",
|
|
32182
32442
|
"KmsKeyId": "The ARN of the AWS Key Management Service ( AWS KMS) master key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` . If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default master key. If you specify this property, you must set the StorageEncrypted property to true.\n\nIf you specify the `SourceDBInstanceIdentifier` property, the value is inherited from the source DB instance if the read replica is created in the same region.\n\nIf you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify `DBSecurityGroups` , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. The KMS key identifier is managed by the DB cluster.",
|
|
32183
|
-
"LicenseModel": "License model information for this DB instance.\n\nValid values
|
|
32443
|
+
"LicenseModel": "License model information for this DB instance.\n\nValid values:\n\n- Aurora MySQL - `general-public-license`\n- Aurora PostgreSQL - `postgresql-license`\n- MariaDB - `general-public-license`\n- Microsoft SQL Server - `license-included`\n- MySQL - `general-public-license`\n- Oracle - `bring-your-own-license` or `license-included`\n- PostgreSQL - `postgresql-license`\n\n> If you've specified `DBSecurityGroups` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.",
|
|
32184
32444
|
"MasterUserPassword": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n\n*Amazon Aurora*\n\nNot applicable. The password for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Microsoft SQL Server*\n\nConstraints: Must contain from 8 to 128 characters.\n\n*MySQL*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Oracle*\n\nConstraints: Must contain from 8 to 30 characters.\n\n*PostgreSQL*\n\nConstraints: Must contain from 8 to 128 characters.",
|
|
32185
32445
|
"MasterUsername": "The master user name for the DB instance.\n\n> If you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot. \n\n*Amazon Aurora*\n\nNot applicable. The name for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints:\n\n- Required for MariaDB.\n- Must be 1 to 16 letters or numbers.\n- Can't be a reserved word for the chosen database engine.\n\n*Microsoft SQL Server*\n\nConstraints:\n\n- Required for SQL Server.\n- Must be 1 to 128 letters or numbers.\n- The first character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*MySQL*\n\nConstraints:\n\n- Required for MySQL.\n- Must be 1 to 16 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*Oracle*\n\nConstraints:\n\n- Required for Oracle.\n- Must be 1 to 30 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*PostgreSQL*\n\nConstraints:\n\n- Required for PostgreSQL.\n- Must be 1 to 63 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.",
|
|
32186
32446
|
"MaxAllocatedStorage": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.\n\nFor more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide* .\n\nThis setting doesn't apply to RDS Custom.",
|
|
@@ -32437,7 +32697,7 @@
|
|
|
32437
32697
|
},
|
|
32438
32698
|
"description": "Creates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application and send it to CloudWatch RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.\n\nAfter you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see [How do I find a code snippet that I've already generated?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)",
|
|
32439
32699
|
"properties": {
|
|
32440
|
-
"AppMonitorConfiguration": "A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include `AppMonitorConfiguration` , you must set up your own authorization method. For more information, see [Authorize your application to send data to AWS](https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html) .\n\nIf you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.",
|
|
32700
|
+
"AppMonitorConfiguration": "A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include `AppMonitorConfiguration` , you must set up your own authorization method. For more information, see [Authorize your application to send data to AWS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html) .\n\nIf you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.",
|
|
32441
32701
|
"CwLogEnabled": "Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.\n\nIf you omit this parameter, the default is `false` .",
|
|
32442
32702
|
"Domain": "The top-level internet domain name for which your application has administrative authority. This parameter is required.",
|
|
32443
32703
|
"Name": "A name for the app monitor. This parameter is required.",
|
|
@@ -34072,24 +34332,24 @@
|
|
|
34072
34332
|
},
|
|
34073
34333
|
"AWS::S3::Bucket.Rule": {
|
|
34074
34334
|
"attributes": {},
|
|
34075
|
-
"description": "Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference* .",
|
|
34335
|
+
"description": "Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference* .\n\nYou must specify at least one of the following properties: `AbortIncompleteMultipartUpload` , `ExpirationDate` , `ExpirationInDays` , `NoncurrentVersionExpirationInDays` , `NoncurrentVersionTransition` , `NoncurrentVersionTransitions` , `Transition` , or `Transitions` .",
|
|
34076
34336
|
"properties": {
|
|
34077
|
-
"AbortIncompleteMultipartUpload": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket
|
|
34078
|
-
"ExpirationDate": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time
|
|
34079
|
-
"ExpirationInDays": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time
|
|
34337
|
+
"AbortIncompleteMultipartUpload": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.",
|
|
34338
|
+
"ExpirationDate": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.",
|
|
34339
|
+
"ExpirationInDays": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.",
|
|
34080
34340
|
"ExpiredObjectDeleteMarker": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with `ExpirationInDays` , `ExpirationDate` , or `TagFilters` .",
|
|
34081
34341
|
"Id": "Unique identifier for the rule. The value can't be longer than 255 characters.",
|
|
34082
34342
|
"NoncurrentVersionExpiration": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.",
|
|
34083
|
-
"NoncurrentVersionExpirationInDays": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time
|
|
34084
|
-
"NoncurrentVersionTransition": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransitions` property
|
|
34085
|
-
"NoncurrentVersionTransitions": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransition` property
|
|
34343
|
+
"NoncurrentVersionExpirationInDays": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.",
|
|
34344
|
+
"NoncurrentVersionTransition": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransitions` property.",
|
|
34345
|
+
"NoncurrentVersionTransitions": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransition` property.",
|
|
34086
34346
|
"ObjectSizeGreaterThan": "Specifies the minimum object size in bytes for this rule to apply to. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide* .",
|
|
34087
34347
|
"ObjectSizeLessThan": "Specifies the maximum object size in bytes for this rule to apply to. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide* .",
|
|
34088
34348
|
"Prefix": "Object key prefix that identifies one or more objects to which this rule applies.\n\n> Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) .",
|
|
34089
34349
|
"Status": "If `Enabled` , the rule is currently being applied. If `Disabled` , the rule is not currently being applied.",
|
|
34090
34350
|
"TagFilters": "Tags to use to identify a subset of objects to which the lifecycle rule applies.",
|
|
34091
|
-
"Transition": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transitions` property
|
|
34092
|
-
"Transitions": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transition` property
|
|
34351
|
+
"Transition": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transitions` property.",
|
|
34352
|
+
"Transitions": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transition` property."
|
|
34093
34353
|
}
|
|
34094
34354
|
},
|
|
34095
34355
|
"AWS::S3::Bucket.S3KeyFilter": {
|
|
@@ -34804,7 +35064,7 @@
|
|
|
34804
35064
|
},
|
|
34805
35065
|
"AWS::SSM::Association": {
|
|
34806
35066
|
"attributes": {
|
|
34807
|
-
"AssociationId": ""
|
|
35067
|
+
"AssociationId": "The association ID."
|
|
34808
35068
|
},
|
|
34809
35069
|
"description": "The `AWS::SSM::Association` resource creates a State Manager association for your managed instances. A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Groups or an AWS Auto Scaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.",
|
|
34810
35070
|
"properties": {
|
|
@@ -34813,7 +35073,7 @@
|
|
|
34813
35073
|
"AutomationTargetParameterName": "Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .",
|
|
34814
35074
|
"CalendarNames": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) .",
|
|
34815
35075
|
"ComplianceSeverity": "The severity level that is assigned to the association.",
|
|
34816
|
-
"DocumentVersion": "The version of the SSM document to associate with the target.",
|
|
35076
|
+
"DocumentVersion": "The version of the SSM document to associate with the target.\n\n> `DocumentVersion` is not valid for documents owned by AWS , such as `AWS-RunPatchBaseline` or `AWS-UpdateSSMAgent` . If you specify `DocumentVersion` for an AWS document, the system returns the following error: \"Error occurred during operation 'CreateAssociation'.\" (RequestToken: <token>, HandlerErrorCode: GeneralServiceException).",
|
|
34817
35077
|
"InstanceId": "The ID of the instance that the SSM document is associated with. You must specify the `InstanceId` or `Targets` property.\n\n> `InstanceId` has been deprecated. To specify an instance ID for an association, use the `Targets` parameter. If you use the parameter `InstanceId` , you cannot use the parameters `AssociationName` , `DocumentVersion` , `MaxErrors` , `MaxConcurrency` , `OutputLocation` , or `ScheduleExpression` . To use these parameters, you must use the `Targets` parameter.",
|
|
34818
35078
|
"MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.\n\nIf a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency` .",
|
|
34819
35079
|
"MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.\n\nExecutions that are already running an association when `MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set `MaxConcurrency` to 1 so that executions proceed one at a time.",
|
|
@@ -34947,6 +35207,14 @@
|
|
|
34947
35207
|
"WindowId": "The ID of the maintenance window where the task is registered."
|
|
34948
35208
|
}
|
|
34949
35209
|
},
|
|
35210
|
+
"AWS::SSM::MaintenanceWindowTask.CloudWatchOutputConfig": {
|
|
35211
|
+
"attributes": {},
|
|
35212
|
+
"description": "Configuration options for sending command output to Amazon CloudWatch Logs.",
|
|
35213
|
+
"properties": {
|
|
35214
|
+
"CloudWatchLogGroupName": "The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format:\n\n`aws/ssm/ *SystemsManagerDocumentName*`",
|
|
35215
|
+
"CloudWatchOutputEnabled": "Enables Systems Manager to send command output to CloudWatch Logs."
|
|
35216
|
+
}
|
|
35217
|
+
},
|
|
34950
35218
|
"AWS::SSM::MaintenanceWindowTask.LoggingInfo": {
|
|
34951
35219
|
"attributes": {},
|
|
34952
35220
|
"description": "The `LoggingInfo` property type specifies information about the Amazon S3 bucket to write instance-level logs to.\n\n`LoggingInfo` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) resource.\n\n> `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) .",
|
|
@@ -34977,9 +35245,11 @@
|
|
|
34977
35245
|
"attributes": {},
|
|
34978
35246
|
"description": "The `MaintenanceWindowRunCommandParameters` property type specifies the parameters for a `RUN_COMMAND` task type for a maintenance window task in AWS Systems Manager . This means that these parameters are the same as those for the `SendCommand` API call. For more information about `SendCommand` parameters, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) in the *AWS Systems Manager API Reference* .\n\nFor information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see [Viewing SSM command document content](https://docs.aws.amazon.com/systems-manager/latest/userguide/viewing-ssm-document-content.html) in the *AWS Systems Manager User Guide* .\n\n`MaintenanceWindowRunCommandParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.",
|
|
34979
35247
|
"properties": {
|
|
35248
|
+
"CloudWatchOutputConfig": "",
|
|
34980
35249
|
"Comment": "Information about the command or commands to run.",
|
|
34981
35250
|
"DocumentHash": "The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.",
|
|
34982
35251
|
"DocumentHashType": "The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.",
|
|
35252
|
+
"DocumentVersion": "The AWS Systems Manager document (SSM document) version to use in the request. You can specify `$DEFAULT` , `$LATEST` , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:\n\n`--document-version \"\\$DEFAULT\"`\n\n`--document-version \"\\$LATEST\"`\n\n`--document-version \"3\"`",
|
|
34983
35253
|
"NotificationConfig": "Configurations for sending notifications about command status changes on a per-managed node basis.",
|
|
34984
35254
|
"OutputS3BucketName": "The name of the Amazon Simple Storage Service (Amazon S3) bucket.",
|
|
34985
35255
|
"OutputS3KeyPrefix": "The S3 bucket subfolder.",
|
|
@@ -35113,7 +35383,7 @@
|
|
|
35113
35383
|
"AWS::SSM::ResourceDataSync": {
|
|
35114
35384
|
"attributes": {
|
|
35115
35385
|
"Ref": "`Ref` returns the name of the resource data sync, such as `TestResourceDataSync` .",
|
|
35116
|
-
"SyncName": ""
|
|
35386
|
+
"SyncName": "The name of the resource data sync."
|
|
35117
35387
|
},
|
|
35118
35388
|
"description": "The `AWS::SSM::ResourceDataSync` resource creates, updates, or deletes a resource data sync for AWS Systems Manager . A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: `SyncToDestination` and `SyncFromSource` .\n\nYou can configure Systems Manager Inventory to use the `SyncToDestination` type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket.\n\nYou can configure Systems Manager Explorer to use the `SyncFromSource` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an `EntireOrganization` by using AWS Organizations .\n\nA resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.\n\nBy default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.\n\nFor more information, see [Configuring Inventory Collection](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync) and [Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the *AWS Systems Manager User Guide* .\n\nImportant: The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Please see the *Examples* section when you create your resource data sync.",
|
|
35119
35389
|
"properties": {
|
|
@@ -36637,6 +36907,7 @@
|
|
|
36637
36907
|
},
|
|
36638
36908
|
"description": "The `AWS::SageMaker::Pipeline` resource creates shell scripts that run when you create and/or start a SageMaker Pipeline. For information about SageMaker Pipelines, see [SageMaker Pipelines](https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines.html) in the *Amazon SageMaker Developer Guide* .",
|
|
36639
36909
|
"properties": {
|
|
36910
|
+
"ParallelismConfiguration": "The parallelism configuration applied to the pipeline.",
|
|
36640
36911
|
"PipelineDefinition": "The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.",
|
|
36641
36912
|
"PipelineDescription": "The description of the pipeline.",
|
|
36642
36913
|
"PipelineDisplayName": "The display name of the pipeline.",
|
|
@@ -36798,8 +37069,8 @@
|
|
|
36798
37069
|
"MasterSecretKmsKeyArn": "The ARN of the KMS key that Secrets Manager uses to encrypt the elevated secret if you use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) . If you don't specify this value and you use the alternating users strategy, 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.",
|
|
36799
37070
|
"RotationLambdaName": "The name of the Lambda rotation function.",
|
|
36800
37071
|
"RotationType": "The type of rotation template to use. For more information, see [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .\n\nYou can specify one of the following `RotationTypes` :\n\n- MySQLSingleUser\n- MySQLMultiUser\n- PostgreSQLSingleUser\n- PostgreSQLMultiUser\n- OracleSingleUser\n- OracleMultiUser\n- MariaDBSingleUser\n- MariaDBMultiUser\n- SQLServerSingleUser\n- SQLServerMultiUser\n- RedshiftSingleUser\n- RedshiftMultiUser\n- MongoDBSingleUser\n- MongoDBMultiUser",
|
|
36801
|
-
"SuperuserSecretArn": "",
|
|
36802
|
-
"SuperuserSecretKmsKeyArn": "",
|
|
37072
|
+
"SuperuserSecretArn": "The ARN of the secret that contains elevated credentials. The Lambda rotation function uses this secret for the [Alternating users rotation strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) .",
|
|
37073
|
+
"SuperuserSecretKmsKeyArn": "The ARN of the KMS key that Secrets Manager uses to encrypt the elevated secret if you use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) . If you don't specify this value and you use the alternating users strategy, 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.",
|
|
36803
37074
|
"VpcSecurityGroupIds": "A comma-separated list of security group IDs applied to the target database.\n\nThe templates applies the same security groups as on the Lambda rotation function that is created as part of this stack.",
|
|
36804
37075
|
"VpcSubnetIds": "A comma separated list of VPC subnet IDs of the target database network. The Lambda rotation function is in the same subnet group."
|
|
36805
37076
|
}
|
|
@@ -36857,7 +37128,7 @@
|
|
|
36857
37128
|
"description": "The `AWS::SecretsManager::SecretTargetAttachment` resource completes the final link between a Secrets Manager secret and the associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order:\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 user name 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.",
|
|
36858
37129
|
"properties": {
|
|
36859
37130
|
"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.",
|
|
36860
|
-
"TargetId": "The
|
|
37131
|
+
"TargetId": "The ID of the database or cluster.",
|
|
36861
37132
|
"TargetType": "A string that defines the type of service or database associated with the secret. This value instructs Secrets Manager how to update the secret with the details of the service or database. This value must be one of the following:\n\n- AWS::RDS::DBInstance\n- AWS::RDS::DBCluster\n- AWS::Redshift::Cluster\n- AWS::DocDB::DBInstance\n- AWS::DocDB::DBCluster"
|
|
36862
37133
|
}
|
|
36863
37134
|
},
|
|
@@ -37211,6 +37482,7 @@
|
|
|
37211
37482
|
"AWS::ServiceDiscovery::PrivateDnsNamespace": {
|
|
37212
37483
|
"attributes": {
|
|
37213
37484
|
"Arn": "The Amazon Resource Name (ARN) of the private namespace.",
|
|
37485
|
+
"HostedZoneId": "",
|
|
37214
37486
|
"Id": "The ID of the private namespace.",
|
|
37215
37487
|
"Ref": "`Ref` returns the value of `Id` for the namespace, such as `ns-e4anhexample0004` ."
|
|
37216
37488
|
},
|
|
@@ -37247,6 +37519,7 @@
|
|
|
37247
37519
|
"AWS::ServiceDiscovery::PublicDnsNamespace": {
|
|
37248
37520
|
"attributes": {
|
|
37249
37521
|
"Arn": "The Amazon Resource Name (ARN) of the public namespace.",
|
|
37522
|
+
"HostedZoneId": "",
|
|
37250
37523
|
"Id": "The ID of the public namespace.",
|
|
37251
37524
|
"Ref": "`Ref` returns the value of `Id` for the namespace, such as `ns-e4anhexample0004` ."
|
|
37252
37525
|
},
|