cdk-common 2.0.161 → 2.0.164
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/package.json +8 -8
- 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 +6894 -6894
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/resource-type.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/specification.ts.html +1 -1
- 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 +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.ts.html +1 -1
- 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 +1 -1
- 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 +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/resource-type.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/specification.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/package.json +3 -3
- package/node_modules/@aws-cdk/cfnspec/spec/cfn-docs.json +420 -81
- package/node_modules/@aws-cdk/cloudformation-diff/package.json +4 -4
- package/node_modules/@types/concat-stream/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/concat-stream/node_modules/@types/node/fs/promises.d.ts +1 -1
- package/node_modules/@types/concat-stream/node_modules/@types/node/fs.d.ts +9 -2
- package/node_modules/@types/concat-stream/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/concat-stream/node_modules/@types/node/timers.d.ts +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/fs/promises.d.ts +1 -1
- package/node_modules/@types/form-data/node_modules/@types/node/fs.d.ts +9 -2
- package/node_modules/@types/form-data/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/form-data/node_modules/@types/node/timers.d.ts +2 -2
- package/package.json +4 -4
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -2928,13 +2928,16 @@
|
|
|
2928
2928
|
"AWS::AppMesh::Mesh.MeshServiceDiscovery": {
|
|
2929
2929
|
"attributes": {},
|
|
2930
2930
|
"description": "An object that represents the service discovery information for a service mesh.",
|
|
2931
|
-
"properties": {
|
|
2931
|
+
"properties": {
|
|
2932
|
+
"IpPreference": "The IP version to use to control traffic within the mesh."
|
|
2933
|
+
}
|
|
2932
2934
|
},
|
|
2933
2935
|
"AWS::AppMesh::Mesh.MeshSpec": {
|
|
2934
2936
|
"attributes": {},
|
|
2935
2937
|
"description": "An object that represents the specification of a service mesh.",
|
|
2936
2938
|
"properties": {
|
|
2937
|
-
"EgressFilter": "The egress filter rules for the service mesh."
|
|
2939
|
+
"EgressFilter": "The egress filter rules for the service mesh.",
|
|
2940
|
+
"ServiceDiscovery": "An object that represents the service discovery information for a service mesh."
|
|
2938
2941
|
}
|
|
2939
2942
|
},
|
|
2940
2943
|
"AWS::AppMesh::Route": {
|
|
@@ -3460,6 +3463,7 @@
|
|
|
3460
3463
|
"description": "An object that represents the AWS Cloud Map service discovery information for your virtual node.\n\n> AWS Cloud Map is not available in the eu-south-1 Region.",
|
|
3461
3464
|
"properties": {
|
|
3462
3465
|
"Attributes": "A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.",
|
|
3466
|
+
"IpPreference": "The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.",
|
|
3463
3467
|
"NamespaceName": "The name of the AWS Cloud Map namespace to use.",
|
|
3464
3468
|
"ServiceName": "The name of the AWS Cloud Map service to use."
|
|
3465
3469
|
}
|
|
@@ -3508,6 +3512,7 @@
|
|
|
3508
3512
|
"description": "An object that represents the DNS service discovery information for your virtual node.",
|
|
3509
3513
|
"properties": {
|
|
3510
3514
|
"Hostname": "Specifies the DNS service discovery hostname for the virtual node.",
|
|
3515
|
+
"IpPreference": "The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.",
|
|
3511
3516
|
"ResponseType": "Specifies the DNS response type for the virtual node."
|
|
3512
3517
|
}
|
|
3513
3518
|
},
|
|
@@ -5934,7 +5939,7 @@
|
|
|
5934
5939
|
"properties": {
|
|
5935
5940
|
"ComputeEnvironmentName": "The name for your compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).",
|
|
5936
5941
|
"ComputeResources": "The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the ** .",
|
|
5937
|
-
"ReplaceComputeEnvironment": "Specifies whether the compute environment should be replaced if an update is made that requires replacing the instances in the compute environment. The default value is `true` . To enable more properties to be updated, set this property to `false` . When changing the value of this property to `false` , no other properties should be changed at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the `UPDATE_ROLLBACK_FAILED` state. You can't update a stack that is in the `UPDATE_ROLLBACK_FAILED` state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see [Continue rolling back an update](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) in the *AWS CloudFormation User Guide* .\n\nThe properties that can't be changed without replacing the compute environment are in the [`ComputeResources`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html) property type: [`AllocationStrategy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy) , [`BidPercentage`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage) , [`Ec2Configuration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`ImageId`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid) , [`InstanceRole`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole) , [`InstanceTypes`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes) , [`LaunchTemplate`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate) , [`MaxvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus) , [`MinvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus) , [`PlacementGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup) , [`SecurityGroupIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids) , [`Subnets`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets) , [](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags) , [`Type`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type) , and [`UpdateToLatestImageVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) .",
|
|
5942
|
+
"ReplaceComputeEnvironment": "Specifies whether the compute environment should be replaced if an update is made that requires replacing the instances in the compute environment. The default value is `true` . To enable more properties to be updated, set this property to `false` . When changing the value of this property to `false` , no other properties should be changed at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the `UPDATE_ROLLBACK_FAILED` state. You can't update a stack that is in the `UPDATE_ROLLBACK_FAILED` state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see [Continue rolling back an update](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) in the *AWS CloudFormation User Guide* .\n\nThe properties that can't be changed without replacing the compute environment are in the [`ComputeResources`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html) property type: [`AllocationStrategy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy) , [`BidPercentage`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage) , [`Ec2Configuration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`ImageId`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid) , [`InstanceRole`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole) , [`InstanceTypes`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes) , [`LaunchTemplate`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate) , [`MaxvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus) , [`MinvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus) , [`PlacementGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup) , [`SecurityGroupIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids) , [`Subnets`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets) , [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags) , [`Type`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type) , and [`UpdateToLatestImageVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) .",
|
|
5938
5943
|
"ServiceRole": "The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see [AWS Batch service IAM role](https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in the *AWS Batch User Guide* .\n\n> If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account. \n\nIf your specified role has a path other than `/` , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name `bar` has a path of `/foo/` then you would specify `/foo/bar` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide* .\n\n> Depending on how you created your AWS Batch service role, its ARN might contain the `service-role` path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the `service-role` path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.",
|
|
5939
5944
|
"State": "The state of the compute environment. If the state is `ENABLED` , then the compute environment accepts jobs from a queue and can scale out automatically based on queues.\n\nIf the state is `ENABLED` , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.\n\nIf the state is `DISABLED` , then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a `STARTING` or `RUNNING` state continue to progress normally. Managed compute environments in the `DISABLED` state don't scale out. However, they scale in to `minvCpus` value after instances become idle.",
|
|
5940
5945
|
"Tags": "The tags applied to the compute environment.",
|
|
@@ -9275,11 +9280,11 @@
|
|
|
9275
9280
|
"description": "The template for verification messages.",
|
|
9276
9281
|
"properties": {
|
|
9277
9282
|
"DefaultEmailOption": "The default email option.",
|
|
9278
|
-
"EmailMessage": "The email
|
|
9279
|
-
"EmailMessageByLink": "The email message template for sending a confirmation link to the user. EmailMessageByLink
|
|
9280
|
-
"EmailSubject": "The subject line for the email message template. EmailSubject
|
|
9281
|
-
"EmailSubjectByLink": "The subject line for the email message template for sending a confirmation link to the user. EmailSubjectByLink is
|
|
9282
|
-
"SmsMessage": "The SMS
|
|
9283
|
+
"EmailMessage": "The template for email messages that Amazon Cognito sends to your users. You can set an `EmailMessage` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration.",
|
|
9284
|
+
"EmailMessageByLink": "The email message template for sending a confirmation link to the user. You can set an `EmailMessageByLink` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration.",
|
|
9285
|
+
"EmailSubject": "The subject line for the email message template. You can set an `EmailSubject` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration.",
|
|
9286
|
+
"EmailSubjectByLink": "The subject line for the email message template for sending a confirmation link to the user. You can set an `EmailSubjectByLink` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration.",
|
|
9287
|
+
"SmsMessage": "The template for SMS messages that Amazon Cognito sends to your users."
|
|
9283
9288
|
}
|
|
9284
9289
|
},
|
|
9285
9290
|
"AWS::Cognito::UserPoolClient": {
|
|
@@ -9296,6 +9301,7 @@
|
|
|
9296
9301
|
"CallbackURLs": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported.",
|
|
9297
9302
|
"ClientName": "The client name for the user pool client you would like to create.",
|
|
9298
9303
|
"DefaultRedirectURI": "The default redirect URI. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported.",
|
|
9304
|
+
"EnablePropagateAdditionalUserContextData": "",
|
|
9299
9305
|
"EnableTokenRevocation": "Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .\n\nIf you don't include this parameter, token revocation is automatically activated for the new user pool client.",
|
|
9300
9306
|
"ExplicitAuthFlows": "The authentication flows that are supported by the user pool clients. Flow names without the `ALLOW_` prefix are no longer supported, in favor of new names with the `ALLOW_` prefix.\n\n> Values with `ALLOW_` prefix must be used only along with the `ALLOW_` prefix. \n\nValid values include:\n\n- `ALLOW_ADMIN_USER_PASSWORD_AUTH` : Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH` . This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.\n- `ALLOW_CUSTOM_AUTH` : Enable AWS Lambda trigger based authentication.\n- `ALLOW_USER_PASSWORD_AUTH` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.\n- `ALLOW_USER_SRP_AUTH` : Enable SRP-based authentication.\n- `ALLOW_REFRESH_TOKEN_AUTH` : Enable authflow to refresh tokens.\n\nIf you don't specify a value for `ExplicitAuthFlows` , your app client activates the `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH` authentication flows.",
|
|
9301
9307
|
"GenerateSecret": "Boolean to specify whether you want to generate a secret for the user pool client being created.",
|
|
@@ -9542,7 +9548,7 @@
|
|
|
9542
9548
|
"ConfigRuleId": "The ID of the AWS Config rule, such as `config-rule-a1bzhi` .",
|
|
9543
9549
|
"Ref": "`Ref` returns the rule name, such as `mystack-MyConfigRule-12ABCFPXHV4OV` ."
|
|
9544
9550
|
},
|
|
9545
|
-
"description": "Specifies an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.\n\nYou can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.\n\nIf you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the `PutConfigRule` action to add the rule to AWS Config , you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the `SourceIdentifier` key. This key is part of the `Source` object, which is part of the `ConfigRule` object.\n\nIf you are adding an AWS managed Config rule, specify the rule's identifier for the `SourceIdentifier` key. To reference AWS managed Config rule identifiers, see [About AWS Managed Config Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) .\n\nFor any new rule that you add, specify the `ConfigRuleName` in the `ConfigRule` object. Do not specify the `ConfigRuleArn` or the `ConfigRuleId` . These values are generated by AWS Config for new rules.\n\nIf you are updating a rule that you added previously, you can specify the rule by `ConfigRuleName` , `ConfigRuleId` , or `ConfigRuleArn` in the `ConfigRule` data type that you use in this request.\n\nThe maximum number of rules that AWS Config supports is
|
|
9551
|
+
"description": "Specifies an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.\n\nYou can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.\n\nIf you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the `PutConfigRule` action to add the rule to AWS Config , you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the `SourceIdentifier` key. This key is part of the `Source` object, which is part of the `ConfigRule` object.\n\nIf you are adding an AWS managed Config rule, specify the rule's identifier for the `SourceIdentifier` key. To reference AWS managed Config rule identifiers, see [About AWS Managed Config Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) .\n\nFor any new rule that you add, specify the `ConfigRuleName` in the `ConfigRule` object. Do not specify the `ConfigRuleArn` or the `ConfigRuleId` . These values are generated by AWS Config for new rules.\n\nIf you are updating a rule that you added previously, you can specify the rule by `ConfigRuleName` , `ConfigRuleId` , or `ConfigRuleArn` in the `ConfigRule` data type that you use in this request.\n\nThe maximum number of rules that AWS Config supports is 400.\n\nFor information about requesting a rule limit increase, see [AWS Config endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/awsconfig.html) in the *AWS General Reference Guide* .\n\nFor more information about developing and using AWS Config rules, see [Evaluating AWS Resource Configurations with AWS Config](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *AWS Config Developer Guide* .",
|
|
9546
9552
|
"properties": {
|
|
9547
9553
|
"ConfigRuleName": "A name for the AWS Config rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .",
|
|
9548
9554
|
"Description": "The description that you provide for the AWS Config rule.",
|
|
@@ -11749,15 +11755,15 @@
|
|
|
11749
11755
|
},
|
|
11750
11756
|
"description": "The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see [Creating a Location for Object Storage](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html) .",
|
|
11751
11757
|
"properties": {
|
|
11752
|
-
"AccessKey": "
|
|
11753
|
-
"AgentArns": "
|
|
11754
|
-
"BucketName": "
|
|
11755
|
-
"SecretKey": "
|
|
11756
|
-
"ServerHostname": "
|
|
11757
|
-
"ServerPort": "
|
|
11758
|
-
"ServerProtocol": "
|
|
11759
|
-
"Subdirectory": "
|
|
11760
|
-
"Tags": "
|
|
11758
|
+
"AccessKey": "Specifies the access key (or user name) if credentials are required to access the object storage server.",
|
|
11759
|
+
"AgentArns": "Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.",
|
|
11760
|
+
"BucketName": "Specifies the name of the bucket that DataSync reads from or writes to.",
|
|
11761
|
+
"SecretKey": "Specifies the secret key (or password) if credentials are required to access the object storage server.",
|
|
11762
|
+
"ServerHostname": "Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server.",
|
|
11763
|
+
"ServerPort": "Specifies the port that your object storage server accepts inbound network traffic on. Set to port 80 (HTTP), 443 (HTTPS), or a custom port if needed.",
|
|
11764
|
+
"ServerProtocol": "Specifies the protocol that your object storage server uses to communicate.",
|
|
11765
|
+
"Subdirectory": "Specifies the object prefix that DataSync reads from or writes to.",
|
|
11766
|
+
"Tags": "Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location. We recommend using tags for naming your locations."
|
|
11761
11767
|
}
|
|
11762
11768
|
},
|
|
11763
11769
|
"AWS::DataSync::LocationS3": {
|
|
@@ -11847,6 +11853,7 @@
|
|
|
11847
11853
|
"Gid": "The group ID (GID) of the file's owners.\n\nDefault value: `INT_VALUE`\n\n`INT_VALUE` : Preserve the integer value of the user ID (UID) and group ID (GID) (recommended).\n\n`NAME` : Currently not supported.\n\n`NONE` : Ignore the UID and GID.",
|
|
11848
11854
|
"LogLevel": "A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) . If set to `OFF` , no logs are published. `BASIC` publishes logs on errors for individual files transferred, and `TRANSFER` publishes logs for every file or object that is transferred and integrity checked.",
|
|
11849
11855
|
"Mtime": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Preserve original `Mtime` (recommended)\n\n`NONE` : Ignore `Mtime` .\n\n> If `Mtime` is set to `PRESERVE` , `Atime` must be set to `BEST_EFFORT` .\n> \n> If `Mtime` is set to `NONE` , `Atime` must also be set to `NONE` .",
|
|
11856
|
+
"ObjectTags": "Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.\n\nDefault Value: `PRESERVE`",
|
|
11850
11857
|
"OverwriteMode": "A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to `NEVER` a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.\n\nSome storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) in the *AWS DataSync User Guide* .",
|
|
11851
11858
|
"PosixPermissions": "A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file. This option should be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see [Metadata Copied by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) .\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Preserve POSIX-style permissions (recommended).\n\n`NONE` : Ignore permissions.\n\n> AWS DataSync can preserve extant permissions of a source location.",
|
|
11852
11859
|
"PreserveDeletedFiles": "A value that specifies whether files in the destination that don't exist in the source file system are preserved. This option can affect your storage costs. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) in the *AWS DataSync User Guide* .\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Ignore destination files that aren't present in the source (recommended).\n\n`REMOVE` : Delete destination files that aren't present in the source.",
|
|
@@ -13528,13 +13535,13 @@
|
|
|
13528
13535
|
"ElasticGpuSpecifications": "An elastic GPU to associate with the instance.",
|
|
13529
13536
|
"ElasticInferenceAccelerators": "The elastic inference accelerator for the instance.",
|
|
13530
13537
|
"EnclaveOptions": "Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is AWS Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *AWS Nitro Enclaves User Guide* .\n\nYou can't enable AWS Nitro Enclaves and hibernation on the same instance.",
|
|
13531
|
-
"HibernationOptions": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/
|
|
13538
|
+
"HibernationOptions": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) . For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide* .",
|
|
13532
13539
|
"IamInstanceProfile": "The name or Amazon Resource Name (ARN) of an IAM instance profile.",
|
|
13533
13540
|
"ImageId": "The ID of the AMI.",
|
|
13534
13541
|
"InstanceInitiatedShutdownBehavior": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n\nDefault: `stop`",
|
|
13535
13542
|
"InstanceMarketOptions": "The market (purchasing) option for the instances.",
|
|
13536
13543
|
"InstanceRequirements": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n\nIf you specify `InstanceRequirements` , you can't specify `InstanceTypes` .",
|
|
13537
|
-
"InstanceType": "The instance type. For more information, see [Instance
|
|
13544
|
+
"InstanceType": "The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide* .\n\nIf you specify `InstanceTypes` , you can't specify `InstanceRequirements` .",
|
|
13538
13545
|
"KernelId": "The ID of the kernel.\n\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .",
|
|
13539
13546
|
"KeyName": "The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .\n\n> If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.",
|
|
13540
13547
|
"LicenseSpecifications": "The license configurations.",
|
|
@@ -13543,11 +13550,11 @@
|
|
|
13543
13550
|
"NetworkInterfaces": "One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.",
|
|
13544
13551
|
"Placement": "The placement for the instance.",
|
|
13545
13552
|
"PrivateDnsNameOptions": "The options for the instance hostname. The default values are inherited from the subnet.",
|
|
13546
|
-
"RamDiskId": "The ID of the RAM disk.\n\n> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User
|
|
13553
|
+
"RamDiskId": "The ID of the RAM disk.\n\n> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide* .",
|
|
13547
13554
|
"SecurityGroupIds": "One or more security group IDs. You can create a security group using [CreateSecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html) . You cannot specify both a security group ID and security name in the same request.",
|
|
13548
13555
|
"SecurityGroups": "[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.",
|
|
13549
13556
|
"TagSpecifications": "The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch.",
|
|
13550
|
-
"UserData": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [
|
|
13557
|
+
"UserData": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide* .\n\nIf you are creating the launch template for use with AWS Batch , the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive) . For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *AWS Batch User Guide* ."
|
|
13551
13558
|
}
|
|
13552
13559
|
},
|
|
13553
13560
|
"AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator": {
|
|
@@ -14742,10 +14749,10 @@
|
|
|
14742
14749
|
"attributes": {
|
|
14743
14750
|
"Ref": "`Ref` returns the ID of the Traffic Mirror target."
|
|
14744
14751
|
},
|
|
14745
|
-
"description": "Specifies a target for your Traffic Mirror session.\n\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.\n\nA Traffic Mirror target can be a network interface, or a
|
|
14752
|
+
"description": "Specifies a target for your Traffic Mirror session.\n\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.\n\nA Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.\n\nTo use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html) .",
|
|
14746
14753
|
"properties": {
|
|
14747
14754
|
"Description": "The description of the Traffic Mirror target.",
|
|
14748
|
-
"GatewayLoadBalancerEndpointId": "",
|
|
14755
|
+
"GatewayLoadBalancerEndpointId": "The ID of the Gateway Load Balancer endpoint.",
|
|
14749
14756
|
"NetworkInterfaceId": "The network interface ID that is associated with the target.",
|
|
14750
14757
|
"NetworkLoadBalancerArn": "The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.",
|
|
14751
14758
|
"Tags": "The tags to assign to the Traffic Mirror target."
|
|
@@ -14950,11 +14957,11 @@
|
|
|
14950
14957
|
},
|
|
14951
14958
|
"AWS::EC2::VPC": {
|
|
14952
14959
|
"attributes": {
|
|
14953
|
-
"CidrBlock": "The
|
|
14954
|
-
"CidrBlockAssociations": "The IPv4 CIDR
|
|
14955
|
-
"DefaultNetworkAcl": "The default network ACL
|
|
14956
|
-
"DefaultSecurityGroup": "The default security group
|
|
14957
|
-
"Ipv6CidrBlocks": "The IPv6 CIDR blocks
|
|
14960
|
+
"CidrBlock": "The primary IPv4 CIDR block for the VPC. For example, 10.0.0.0/16.",
|
|
14961
|
+
"CidrBlockAssociations": "The association IDs of the IPv4 CIDR blocks for the VPC. For example, [ vpc-cidr-assoc-0280ab6b ].",
|
|
14962
|
+
"DefaultNetworkAcl": "The ID of the default network ACL for the VPC. For example, acl-814dafe3.",
|
|
14963
|
+
"DefaultSecurityGroup": "The ID of the default security group for the VPC. For example, sg-b178e0d3.",
|
|
14964
|
+
"Ipv6CidrBlocks": "The IPv6 CIDR blocks for the VPC. For example, [ 2001:db8:1234:1a00::/56 ].",
|
|
14958
14965
|
"Ref": "`Ref` returns the ID of the VPC.",
|
|
14959
14966
|
"VpcId": ""
|
|
14960
14967
|
},
|
|
@@ -14963,7 +14970,7 @@
|
|
|
14963
14970
|
"CidrBlock": "The IPv4 network range for the VPC, in CIDR notation. For example, `10.0.0.0/16` . We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18` , we modify it to `100.68.0.0/18` .\n\nYou must specify either `CidrBlock` or `Ipv4IpamPoolId` .",
|
|
14964
14971
|
"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.",
|
|
14965
14972
|
"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) .",
|
|
14966
|
-
"InstanceTenancy": "The allowed tenancy of instances launched into the VPC.\n\n-
|
|
14973
|
+
"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 runs on dedicated hardware 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.",
|
|
14967
14974
|
"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* .\n\nYou must specify either `CidrBlock` or `Ipv4IpamPoolId` .",
|
|
14968
14975
|
"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* .",
|
|
14969
14976
|
"Tags": "The tags for the VPC."
|
|
@@ -17791,7 +17798,7 @@
|
|
|
17791
17798
|
"DomainEndpoint": "The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as `search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .",
|
|
17792
17799
|
"Ref": "When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name, such as `mystack-elasticsea-abc1d2efg3h4.` For more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) ."
|
|
17793
17800
|
},
|
|
17794
|
-
"description": "The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service
|
|
17801
|
+
"description": "The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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. 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) .",
|
|
17795
17802
|
"properties": {
|
|
17796
17803
|
"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 Guid* e.",
|
|
17797
17804
|
"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* .",
|
|
@@ -17824,9 +17831,9 @@
|
|
|
17824
17831
|
"description": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17825
17832
|
"properties": {
|
|
17826
17833
|
"Enabled": "Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See [Amazon Cognito authentication for OpenSearch Dashboards](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) .",
|
|
17827
|
-
"IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.",
|
|
17828
|
-
"RoleArn": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool.",
|
|
17829
|
-
"UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication."
|
|
17834
|
+
"IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. Required if you enable Cognito authentication.",
|
|
17835
|
+
"RoleArn": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool. Required if you enable Cognito authentication.",
|
|
17836
|
+
"UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. Required if you enable Cognito authentication."
|
|
17830
17837
|
}
|
|
17831
17838
|
},
|
|
17832
17839
|
"AWS::Elasticsearch::Domain.ColdStorageOptions": {
|
|
@@ -17840,8 +17847,8 @@
|
|
|
17840
17847
|
"attributes": {},
|
|
17841
17848
|
"description": "Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17842
17849
|
"properties": {
|
|
17843
|
-
"CustomEndpoint": "The fully qualified URL for your custom endpoint.",
|
|
17844
|
-
"CustomEndpointCertificateArn": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate.",
|
|
17850
|
+
"CustomEndpoint": "The fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint for the domain.",
|
|
17851
|
+
"CustomEndpointCertificateArn": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate. Required if you enabled a custom endpoint for the domain.",
|
|
17845
17852
|
"CustomEndpointEnabled": "True to enable a custom endpoint for the domain. If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn` .",
|
|
17846
17853
|
"EnforceHTTPS": "True to require that all traffic to the domain arrive over HTTPS.",
|
|
17847
17854
|
"TLSSecurityPolicy": "The minimum TLS version required for traffic to the domain. Valid values are TLS 1.0 (default) or 1.2:\n\n- `Policy-Min-TLS-1-0-2019-07`\n- `Policy-Min-TLS-1-2-2019-07`"
|
|
@@ -17867,9 +17874,9 @@
|
|
|
17867
17874
|
"DedicatedMasterType": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.elasticsearch` . If you specify this property, you must specify true for the `DedicatedMasterEnabled` property. For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) .",
|
|
17868
17875
|
"InstanceCount": "The number of data nodes (instances) to use in the OpenSearch Service domain.",
|
|
17869
17876
|
"InstanceType": "The instance type for your data nodes, such as `m3.medium.elasticsearch` . For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) .",
|
|
17870
|
-
"WarmCount": "The number of warm nodes in the cluster.",
|
|
17877
|
+
"WarmCount": "The number of warm nodes in the cluster. Required if you enable warm storage.",
|
|
17871
17878
|
"WarmEnabled": "Whether to enable warm storage for the cluster.",
|
|
17872
|
-
"WarmType": "The instance type for the cluster's warm nodes.",
|
|
17879
|
+
"WarmType": "The instance type for the cluster's warm nodes. Required if you enable warm storage.",
|
|
17873
17880
|
"ZoneAwarenessConfig": "Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .",
|
|
17874
17881
|
"ZoneAwarenessEnabled": "Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) ."
|
|
17875
17882
|
}
|
|
@@ -17879,20 +17886,20 @@
|
|
|
17879
17886
|
"description": "Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17880
17887
|
"properties": {
|
|
17881
17888
|
"Enabled": "Specify `true` to enable encryption at rest.",
|
|
17882
|
-
"KmsKeyId": "The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` ."
|
|
17889
|
+
"KmsKeyId": "The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` . Required if you enable encryption at rest."
|
|
17883
17890
|
}
|
|
17884
17891
|
},
|
|
17885
17892
|
"AWS::Elasticsearch::Domain.LogPublishingOption": {
|
|
17886
17893
|
"attributes": {},
|
|
17887
17894
|
"description": "> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* . \n\nSpecifies whether the OpenSearch Service domain publishes the Elasticsearch application, search slow logs, or index slow logs to Amazon CloudWatch. Each option must be an object of name `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , or `AUDIT_LOGS` depending on the type of logs you want to publish.\n\nIf you enable a slow log, you still have to enable the *collection* of slow logs using the Configuration API. To learn more, see [Enabling log publishing ( AWS CLI)](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html#createdomain-configure-slow-logs-cli) .",
|
|
17888
17895
|
"properties": {
|
|
17889
|
-
"CloudWatchLogsLogGroupArn": "Specifies the CloudWatch log group to publish to.",
|
|
17896
|
+
"CloudWatchLogsLogGroupArn": "Specifies the CloudWatch log group to publish to. Required if you enable log publishing for the domain.",
|
|
17890
17897
|
"Enabled": "If `true` , enables the publishing of logs to CloudWatch.\n\nDefault: `false` ."
|
|
17891
17898
|
}
|
|
17892
17899
|
},
|
|
17893
17900
|
"AWS::Elasticsearch::Domain.MasterUserOptions": {
|
|
17894
17901
|
"attributes": {},
|
|
17895
|
-
"description": "Specifies information about the master user.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17902
|
+
"description": "Specifies information about the master user. Required if you enabled the internal user database.\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17896
17903
|
"properties": {
|
|
17897
17904
|
"MasterUserARN": "ARN for the master user. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions` .",
|
|
17898
17905
|
"MasterUserName": "Username for the master user. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions` .",
|
|
@@ -17918,7 +17925,7 @@
|
|
|
17918
17925
|
"description": "The virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .\n\n> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy 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 Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .",
|
|
17919
17926
|
"properties": {
|
|
17920
17927
|
"SecurityGroupIds": "The list of security group IDs that are associated with the VPC endpoints for the domain. If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide* .",
|
|
17921
|
-
"SubnetIds": "Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* ."
|
|
17928
|
+
"SubnetIds": "Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .\n\nRequired if you're creating your domain inside a VPC."
|
|
17922
17929
|
}
|
|
17923
17930
|
},
|
|
17924
17931
|
"AWS::Elasticsearch::Domain.ZoneAwarenessConfig": {
|
|
@@ -18129,7 +18136,7 @@
|
|
|
18129
18136
|
"Description": "A description for the endpoint.",
|
|
18130
18137
|
"EventBuses": "The event buses being used by the endpoint.\n\n*Exactly* : `2`",
|
|
18131
18138
|
"Name": "The name of the endpoint.",
|
|
18132
|
-
"ReplicationConfig": "Whether event replication was enabled or disabled for this endpoint.",
|
|
18139
|
+
"ReplicationConfig": "Whether event replication was enabled or disabled for this endpoint. The default state is `ENABLED` which means you must supply a `RoleArn` . If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED` .",
|
|
18133
18140
|
"RoleArn": "The ARN of the role used by event replication for the endpoint.",
|
|
18134
18141
|
"RoutingConfig": "The routing configuration of the endpoint."
|
|
18135
18142
|
}
|
|
@@ -26016,7 +26023,7 @@
|
|
|
26016
26023
|
"attributes": {},
|
|
26017
26024
|
"description": "Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. We suggest that you use a CMK from your account to help secure your index. Amazon Kendra doesn't support asymmetric CMKs.",
|
|
26018
26025
|
"properties": {
|
|
26019
|
-
"KmsKeyId": "The identifier of the AWS KMS
|
|
26026
|
+
"KmsKeyId": "The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys."
|
|
26020
26027
|
}
|
|
26021
26028
|
},
|
|
26022
26029
|
"AWS::Kendra::Index.UserTokenConfiguration": {
|
|
@@ -28810,7 +28817,7 @@
|
|
|
28810
28817
|
"LoadBalancerArn": "The Amazon Resource Name (ARN) of the load balancer.",
|
|
28811
28818
|
"Ref": ""
|
|
28812
28819
|
},
|
|
28813
|
-
"description": "The `AWS::Lightsail::LoadBalancer` resource specifies a load balancer that can be used with Lightsail instances.\n\n> You cannot attach
|
|
28820
|
+
"description": "The `AWS::Lightsail::LoadBalancer` resource specifies a load balancer that can be used with Lightsail instances.\n\n> You cannot attach a TLS certificate to a load balancer using the `AWS::Lightsail::LoadBalancer` resource type. Instead, use the `AWS::Lightsail::LoadBalancerTlsCertificate` resource type to create a certificate and attach it to a load balancer.",
|
|
28814
28821
|
"properties": {
|
|
28815
28822
|
"AttachedInstances": "The Lightsail instances to attach to the load balancer.",
|
|
28816
28823
|
"HealthCheckPath": "The path on the attached instance where the health check will be performed. If no path is specified, the load balancer tries to make a request to the default (root) page ( `/index.html` ).",
|
|
@@ -28819,7 +28826,8 @@
|
|
|
28819
28826
|
"LoadBalancerName": "The name of the load balancer.",
|
|
28820
28827
|
"SessionStickinessEnabled": "A Boolean value indicating whether session stickiness is enabled.\n\nEnable session stickiness (also known as *session affinity* ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.",
|
|
28821
28828
|
"SessionStickinessLBCookieDurationSeconds": "The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.",
|
|
28822
|
-
"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."
|
|
28829
|
+
"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.",
|
|
28830
|
+
"TlsPolicyName": "The name of the TLS security policy for the load balancer."
|
|
28823
28831
|
}
|
|
28824
28832
|
},
|
|
28825
28833
|
"AWS::Lightsail::LoadBalancerTlsCertificate": {
|
|
@@ -28833,6 +28841,7 @@
|
|
|
28833
28841
|
"CertificateAlternativeNames": "An array of alternative domain names and subdomain names for your SSL/TLS certificate.\n\nIn addition to the primary domain name, you can have up to nine alternative domain names. Wildcards (such as `*.example.com` ) are not supported.",
|
|
28834
28842
|
"CertificateDomainName": "The domain name for the SSL/TLS certificate. For example, `example.com` or `www.example.com` .",
|
|
28835
28843
|
"CertificateName": "The name of the SSL/TLS certificate.",
|
|
28844
|
+
"HttpsRedirectionEnabled": "A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.",
|
|
28836
28845
|
"IsAttached": "A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.",
|
|
28837
28846
|
"LoadBalancerName": "The name of the load balancer that the SSL/TLS certificate is attached to."
|
|
28838
28847
|
}
|
|
@@ -29195,10 +29204,10 @@
|
|
|
29195
29204
|
"attributes": {},
|
|
29196
29205
|
"description": "Contains information about how the source data should be interpreted.",
|
|
29197
29206
|
"properties": {
|
|
29198
|
-
"AppFlowConfig": "
|
|
29199
|
-
"CloudwatchConfig": "
|
|
29200
|
-
"RDSSourceConfig": "
|
|
29201
|
-
"RedshiftSourceConfig": "
|
|
29207
|
+
"AppFlowConfig": "Details about an AppFlow datasource.",
|
|
29208
|
+
"CloudwatchConfig": "Details about an Amazon CloudWatch monitoring datasource.",
|
|
29209
|
+
"RDSSourceConfig": "Details about an Amazon Relational Database Service (RDS) datasource.",
|
|
29210
|
+
"RedshiftSourceConfig": "Details about an Amazon Redshift database datasource.",
|
|
29202
29211
|
"S3SourceConfig": "Contains information about the configuration of the S3 bucket that contains source files."
|
|
29203
29212
|
}
|
|
29204
29213
|
},
|
|
@@ -32229,7 +32238,7 @@
|
|
|
32229
32238
|
"description": "Specifies a MemoryDB user. For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) .",
|
|
32230
32239
|
"properties": {
|
|
32231
32240
|
"AccessString": "Access permissions string used for this user.",
|
|
32232
|
-
"AuthenticationMode": "Denotes whether the user requires a password to authenticate
|
|
32241
|
+
"AuthenticationMode": "Denotes whether the user requires a password to authenticate.\n\n*Example:*\n\n`mynewdbuser: Type: AWS::MemoryDB::User Properties: AccessString: on ~* &* +@all AuthenticationMode: Passwords: '1234567890123456' Type: password UserName: mynewdbuser AuthenticationMode: { \"Passwords\": [\"1234567890123456\"], \"Type\": \"Password\" }`",
|
|
32233
32242
|
"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) .",
|
|
32234
32243
|
"UserName": "The name of the user."
|
|
32235
32244
|
}
|
|
@@ -33107,7 +33116,7 @@
|
|
|
33107
33116
|
"Id": "The resource ID. For example, `123456789012/my-domain` .",
|
|
33108
33117
|
"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) ."
|
|
33109
33118
|
},
|
|
33110
|
-
"description": "The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service
|
|
33119
|
+
"description": "The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch 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) .",
|
|
33111
33120
|
"properties": {
|
|
33112
33121
|
"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* .",
|
|
33113
33122
|
"AdvancedOptions": "Additional options to specify for the OpenSearch Service domain. For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-advancedoptions) in the OpenSearch Service configuration API reference.",
|
|
@@ -36591,7 +36600,7 @@
|
|
|
36591
36600
|
"Arn": "The Amazon Resource Name (ARN) of the fleet, such as `arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711` .",
|
|
36592
36601
|
"Ref": "When you pass the logical ID of an `AWS::RoboMaker::Fleet` resource to the intrinsic `Ref` function, the function returns the Amazon Resource Name (ARN) of the fleet, such as `arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711` ."
|
|
36593
36602
|
},
|
|
36594
|
-
"description": "The `AWS::RoboMaker::Fleet` resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.",
|
|
36603
|
+
"description": "> The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.\n> \n> We recommend migrating to AWS IoT Greengrass Version 2. For more information, see [Support Changes: May 2, 2022](https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-may2022) in the *AWS RoboMaker Developer Guide* . \n\nThe `AWS::RoboMaker::Fleet` resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.",
|
|
36595
36604
|
"properties": {
|
|
36596
36605
|
"Name": "The name of the fleet.",
|
|
36597
36606
|
"Tags": "The list of all tags added to the fleet."
|
|
@@ -36602,7 +36611,7 @@
|
|
|
36602
36611
|
"Arn": "The Amazon Resource Name (ARN) of the robot.",
|
|
36603
36612
|
"Ref": "When you pass the logical ID of an `AWS::RoboMaker::Robot` resource to the intrinsic `Ref` function, the function returns the Amazon Resource Name (ARN) of the robot application, such as `arn:aws:robomaker:us-west-2:123456789012:robot/MyRobot/1544035373264` ."
|
|
36604
36613
|
},
|
|
36605
|
-
"description": "The `AWS::RoboMaker::RobotApplication` resource creates an AWS RoboMaker robot.",
|
|
36614
|
+
"description": "> The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.\n> \n> We recommend migrating to AWS IoT Greengrass Version 2. For more information, see [Support Changes: May 2, 2022](https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-may2022) in the *AWS RoboMaker Developer Guide* . \n\nThe `AWS::RoboMaker::RobotApplication` resource creates an AWS RoboMaker robot.",
|
|
36606
36615
|
"properties": {
|
|
36607
36616
|
"Architecture": "The architecture of the robot.",
|
|
36608
36617
|
"Fleet": "The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.",
|
|
@@ -38935,6 +38944,21 @@
|
|
|
38935
38944
|
"ChatbotSns": "The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics"
|
|
38936
38945
|
}
|
|
38937
38946
|
},
|
|
38947
|
+
"AWS::SSMIncidents::ResponsePlan.DynamicSsmParameter": {
|
|
38948
|
+
"attributes": {},
|
|
38949
|
+
"description": "",
|
|
38950
|
+
"properties": {
|
|
38951
|
+
"Key": "",
|
|
38952
|
+
"Value": ""
|
|
38953
|
+
}
|
|
38954
|
+
},
|
|
38955
|
+
"AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue": {
|
|
38956
|
+
"attributes": {},
|
|
38957
|
+
"description": "",
|
|
38958
|
+
"properties": {
|
|
38959
|
+
"Variable": ""
|
|
38960
|
+
}
|
|
38961
|
+
},
|
|
38938
38962
|
"AWS::SSMIncidents::ResponsePlan.IncidentTemplate": {
|
|
38939
38963
|
"attributes": {},
|
|
38940
38964
|
"description": "The `IncidentTemplate` property type specifies details used to create an incident when using this response plan.",
|
|
@@ -38959,6 +38983,7 @@
|
|
|
38959
38983
|
"properties": {
|
|
38960
38984
|
"DocumentName": "The automation document's name.",
|
|
38961
38985
|
"DocumentVersion": "The automation document's version to use when running.",
|
|
38986
|
+
"DynamicParameters": "",
|
|
38962
38987
|
"Parameters": "The key-value pair parameters to use when running the automation document.",
|
|
38963
38988
|
"RoleArn": "The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.",
|
|
38964
38989
|
"TargetAccount": "The account that the automation document will be run in. This can be in either the management account or an application account."
|
|
@@ -39950,6 +39975,319 @@
|
|
|
39950
39975
|
"Subnets": "The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) ."
|
|
39951
39976
|
}
|
|
39952
39977
|
},
|
|
39978
|
+
"AWS::SageMaker::ModelPackage": {
|
|
39979
|
+
"attributes": {
|
|
39980
|
+
"CreationTime": "",
|
|
39981
|
+
"ModelPackageArn": "",
|
|
39982
|
+
"ModelPackageStatus": "",
|
|
39983
|
+
"Ref": ""
|
|
39984
|
+
},
|
|
39985
|
+
"description": "A versioned model that can be deployed for SageMaker inference.",
|
|
39986
|
+
"properties": {
|
|
39987
|
+
"AdditionalInferenceSpecificationDefinition": "",
|
|
39988
|
+
"AdditionalInferenceSpecifications": "An array of additional Inference Specification objects.",
|
|
39989
|
+
"AdditionalInferenceSpecificationsToAdd": "",
|
|
39990
|
+
"ApprovalDescription": "A description provided when the model approval is set.",
|
|
39991
|
+
"CertifyForMarketplace": "Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see [List Your Algorithm or Model Package on AWS Marketplace](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html) .",
|
|
39992
|
+
"ClientToken": "",
|
|
39993
|
+
"CreatedBy": "",
|
|
39994
|
+
"CustomerMetadataProperties": "The metadata properties for the model package.",
|
|
39995
|
+
"Domain": "The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.",
|
|
39996
|
+
"DriftCheckBaselines": "Represents the drift check baselines that can be used when the model monitor is set using the model package.",
|
|
39997
|
+
"Environment": "The environment variables to set in the Docker container. Each key and value in the `Environment` string to string map can have length of up to 1024. We support up to 16 entries in the map.",
|
|
39998
|
+
"InferenceSpecification": "",
|
|
39999
|
+
"LastModifiedBy": "",
|
|
40000
|
+
"LastModifiedTime": "The last time the model package was modified.",
|
|
40001
|
+
"MetadataProperties": "",
|
|
40002
|
+
"ModelApprovalStatus": "The approval status of the model. This can be one of the following values.\n\n- `APPROVED` - The model is approved\n- `REJECTED` - The model is rejected.\n- `PENDING_MANUAL_APPROVAL` - The model is waiting for manual approval.",
|
|
40003
|
+
"ModelMetrics": "Metrics for the model.",
|
|
40004
|
+
"ModelPackageDescription": "The description of the model package.",
|
|
40005
|
+
"ModelPackageGroupName": "The model group to which the model belongs.",
|
|
40006
|
+
"ModelPackageName": "The name of the model.",
|
|
40007
|
+
"ModelPackageStatusDetails": "",
|
|
40008
|
+
"ModelPackageStatusItem": "",
|
|
40009
|
+
"ModelPackageVersion": "The version number of a versioned model.",
|
|
40010
|
+
"SamplePayloadUrl": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).",
|
|
40011
|
+
"SourceAlgorithmSpecification": "",
|
|
40012
|
+
"Tag": "",
|
|
40013
|
+
"Tags": "A list of the tags associated with the model package. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference Guide* .",
|
|
40014
|
+
"Task": "The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.",
|
|
40015
|
+
"ValidationSpecification": ""
|
|
40016
|
+
}
|
|
40017
|
+
},
|
|
40018
|
+
"AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition": {
|
|
40019
|
+
"attributes": {},
|
|
40020
|
+
"description": "A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package",
|
|
40021
|
+
"properties": {
|
|
40022
|
+
"Containers": "The Amazon ECR registry path of the Docker image that contains the inference code.",
|
|
40023
|
+
"Description": "A description of the additional Inference specification",
|
|
40024
|
+
"Name": "A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.",
|
|
40025
|
+
"SupportedContentTypes": "The supported MIME types for the input data.",
|
|
40026
|
+
"SupportedRealtimeInferenceInstanceTypes": "A list of the instance types that are used to generate inferences in real-time.",
|
|
40027
|
+
"SupportedResponseMIMETypes": "The supported MIME types for the output data.",
|
|
40028
|
+
"SupportedTransformInstanceTypes": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed."
|
|
40029
|
+
}
|
|
40030
|
+
},
|
|
40031
|
+
"AWS::SageMaker::ModelPackage.Bias": {
|
|
40032
|
+
"attributes": {},
|
|
40033
|
+
"description": "Contains bias metrics for a model.",
|
|
40034
|
+
"properties": {
|
|
40035
|
+
"PostTrainingReport": "",
|
|
40036
|
+
"PreTrainingReport": "",
|
|
40037
|
+
"Report": "The bias report for a model"
|
|
40038
|
+
}
|
|
40039
|
+
},
|
|
40040
|
+
"AWS::SageMaker::ModelPackage.CreatedBy": {
|
|
40041
|
+
"attributes": {},
|
|
40042
|
+
"description": "",
|
|
40043
|
+
"properties": {}
|
|
40044
|
+
},
|
|
40045
|
+
"AWS::SageMaker::ModelPackage.DataSource": {
|
|
40046
|
+
"attributes": {},
|
|
40047
|
+
"description": "Describes the location of the channel data.",
|
|
40048
|
+
"properties": {
|
|
40049
|
+
"S3DataSource": "The S3 location of the data source that is associated with a channel."
|
|
40050
|
+
}
|
|
40051
|
+
},
|
|
40052
|
+
"AWS::SageMaker::ModelPackage.DriftCheckBaselines": {
|
|
40053
|
+
"attributes": {},
|
|
40054
|
+
"description": "Represents the drift check baselines that can be used when the model monitor is set using the model package.",
|
|
40055
|
+
"properties": {
|
|
40056
|
+
"Bias": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package.",
|
|
40057
|
+
"Explainability": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.",
|
|
40058
|
+
"ModelDataQuality": "Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.",
|
|
40059
|
+
"ModelQuality": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package."
|
|
40060
|
+
}
|
|
40061
|
+
},
|
|
40062
|
+
"AWS::SageMaker::ModelPackage.DriftCheckBias": {
|
|
40063
|
+
"attributes": {},
|
|
40064
|
+
"description": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package.",
|
|
40065
|
+
"properties": {
|
|
40066
|
+
"ConfigFile": "The bias config file for a model.",
|
|
40067
|
+
"PostTrainingConstraints": "",
|
|
40068
|
+
"PreTrainingConstraints": ""
|
|
40069
|
+
}
|
|
40070
|
+
},
|
|
40071
|
+
"AWS::SageMaker::ModelPackage.DriftCheckExplainability": {
|
|
40072
|
+
"attributes": {},
|
|
40073
|
+
"description": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.",
|
|
40074
|
+
"properties": {
|
|
40075
|
+
"ConfigFile": "The explainability config file for the model.",
|
|
40076
|
+
"Constraints": ""
|
|
40077
|
+
}
|
|
40078
|
+
},
|
|
40079
|
+
"AWS::SageMaker::ModelPackage.DriftCheckModelDataQuality": {
|
|
40080
|
+
"attributes": {},
|
|
40081
|
+
"description": "Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.",
|
|
40082
|
+
"properties": {
|
|
40083
|
+
"Constraints": "",
|
|
40084
|
+
"Statistics": ""
|
|
40085
|
+
}
|
|
40086
|
+
},
|
|
40087
|
+
"AWS::SageMaker::ModelPackage.DriftCheckModelQuality": {
|
|
40088
|
+
"attributes": {},
|
|
40089
|
+
"description": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.",
|
|
40090
|
+
"properties": {
|
|
40091
|
+
"Constraints": "",
|
|
40092
|
+
"Statistics": ""
|
|
40093
|
+
}
|
|
40094
|
+
},
|
|
40095
|
+
"AWS::SageMaker::ModelPackage.Environment": {
|
|
40096
|
+
"attributes": {},
|
|
40097
|
+
"description": "",
|
|
40098
|
+
"properties": {}
|
|
40099
|
+
},
|
|
40100
|
+
"AWS::SageMaker::ModelPackage.Explainability": {
|
|
40101
|
+
"attributes": {},
|
|
40102
|
+
"description": "Contains explainability metrics for a model.",
|
|
40103
|
+
"properties": {
|
|
40104
|
+
"Report": "The explainability report for a model."
|
|
40105
|
+
}
|
|
40106
|
+
},
|
|
40107
|
+
"AWS::SageMaker::ModelPackage.FileSource": {
|
|
40108
|
+
"attributes": {},
|
|
40109
|
+
"description": "Contains details regarding the file source.",
|
|
40110
|
+
"properties": {
|
|
40111
|
+
"ContentDigest": "The digest of the file source.",
|
|
40112
|
+
"ContentType": "The type of content stored in the file source.",
|
|
40113
|
+
"S3Uri": "The Amazon S3 URI for the file source."
|
|
40114
|
+
}
|
|
40115
|
+
},
|
|
40116
|
+
"AWS::SageMaker::ModelPackage.InferenceSpecification": {
|
|
40117
|
+
"attributes": {},
|
|
40118
|
+
"description": "Defines how to perform inference generation after a training job is run.",
|
|
40119
|
+
"properties": {
|
|
40120
|
+
"Containers": "The Amazon ECR registry path of the Docker image that contains the inference code.",
|
|
40121
|
+
"SupportedContentTypes": "The supported MIME types for the input data.",
|
|
40122
|
+
"SupportedRealtimeInferenceInstanceTypes": "A list of the instance types that are used to generate inferences in real-time.\n\nThis parameter is required for unversioned models, and optional for versioned models.",
|
|
40123
|
+
"SupportedResponseMIMETypes": "The supported MIME types for the output data.",
|
|
40124
|
+
"SupportedTransformInstanceTypes": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.\n\nThis parameter is required for unversioned models, and optional for versioned models."
|
|
40125
|
+
}
|
|
40126
|
+
},
|
|
40127
|
+
"AWS::SageMaker::ModelPackage.LastModifiedBy": {
|
|
40128
|
+
"attributes": {},
|
|
40129
|
+
"description": "",
|
|
40130
|
+
"properties": {}
|
|
40131
|
+
},
|
|
40132
|
+
"AWS::SageMaker::ModelPackage.MetadataProperties": {
|
|
40133
|
+
"attributes": {},
|
|
40134
|
+
"description": "Metadata properties of the tracking entity, trial, or trial component.",
|
|
40135
|
+
"properties": {
|
|
40136
|
+
"CommitId": "The commit ID.",
|
|
40137
|
+
"GeneratedBy": "The entity this entity was generated by.",
|
|
40138
|
+
"ProjectId": "The project ID.",
|
|
40139
|
+
"Repository": "The repository."
|
|
40140
|
+
}
|
|
40141
|
+
},
|
|
40142
|
+
"AWS::SageMaker::ModelPackage.MetricsSource": {
|
|
40143
|
+
"attributes": {},
|
|
40144
|
+
"description": "",
|
|
40145
|
+
"properties": {
|
|
40146
|
+
"ContentDigest": "",
|
|
40147
|
+
"ContentType": "",
|
|
40148
|
+
"S3Uri": ""
|
|
40149
|
+
}
|
|
40150
|
+
},
|
|
40151
|
+
"AWS::SageMaker::ModelPackage.ModelDataQuality": {
|
|
40152
|
+
"attributes": {},
|
|
40153
|
+
"description": "Data quality constraints and statistics for a model.",
|
|
40154
|
+
"properties": {
|
|
40155
|
+
"Constraints": "Data quality constraints for a model.",
|
|
40156
|
+
"Statistics": "Data quality statistics for a model."
|
|
40157
|
+
}
|
|
40158
|
+
},
|
|
40159
|
+
"AWS::SageMaker::ModelPackage.ModelMetrics": {
|
|
40160
|
+
"attributes": {},
|
|
40161
|
+
"description": "Contains metrics captured from a model.",
|
|
40162
|
+
"properties": {
|
|
40163
|
+
"Bias": "Metrics that measure bais in a model.",
|
|
40164
|
+
"Explainability": "Metrics that help explain a model.",
|
|
40165
|
+
"ModelDataQuality": "Metrics that measure the quality of the input data for a model.",
|
|
40166
|
+
"ModelQuality": "Metrics that measure the quality of a model."
|
|
40167
|
+
}
|
|
40168
|
+
},
|
|
40169
|
+
"AWS::SageMaker::ModelPackage.ModelPackageContainerDefinition": {
|
|
40170
|
+
"attributes": {},
|
|
40171
|
+
"description": "Describes the Docker container for the model package.",
|
|
40172
|
+
"properties": {
|
|
40173
|
+
"ContainerHostname": "The DNS host name for the Docker container.",
|
|
40174
|
+
"Environment": "The environment variables to set in the Docker container. Each key and value in the `Environment` string to string map can have length of up to 1024. We support up to 16 entries in the map.",
|
|
40175
|
+
"Framework": "The machine learning framework of the model package container image.",
|
|
40176
|
+
"FrameworkVersion": "The framework version of the Model Package Container Image.",
|
|
40177
|
+
"Image": "The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.\n\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both `registry/repository[:tag]` and `registry/repository[@digest]` image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) .",
|
|
40178
|
+
"ImageDigest": "An MD5 hash of the training algorithm that identifies the Docker image used for training.",
|
|
40179
|
+
"ModelDataUrl": "The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single `gzip` compressed tar archive ( `.tar.gz` suffix).\n\n> The model artifacts must be in an S3 bucket that is in the same region as the model package.",
|
|
40180
|
+
"ModelInput": "A structure with Model Input details.",
|
|
40181
|
+
"NearestModelName": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling `ListModelMetadata` .",
|
|
40182
|
+
"ProductId": "The AWS Marketplace product ID of the model package."
|
|
40183
|
+
}
|
|
40184
|
+
},
|
|
40185
|
+
"AWS::SageMaker::ModelPackage.ModelPackageStatusDetails": {
|
|
40186
|
+
"attributes": {},
|
|
40187
|
+
"description": "Specifies the validation and image scan statuses of the model package.",
|
|
40188
|
+
"properties": {
|
|
40189
|
+
"ImageScanStatuses": "The status of the scan of the Docker image container for the model package.",
|
|
40190
|
+
"ValidationStatuses": "The validation status of the model package."
|
|
40191
|
+
}
|
|
40192
|
+
},
|
|
40193
|
+
"AWS::SageMaker::ModelPackage.ModelPackageStatusItem": {
|
|
40194
|
+
"attributes": {},
|
|
40195
|
+
"description": "Represents the overall status of a model package.",
|
|
40196
|
+
"properties": {
|
|
40197
|
+
"FailureReason": "if the overall status is `Failed` , the reason for the failure.",
|
|
40198
|
+
"Name": "The name of the model package for which the overall status is being reported.",
|
|
40199
|
+
"Status": "The current status."
|
|
40200
|
+
}
|
|
40201
|
+
},
|
|
40202
|
+
"AWS::SageMaker::ModelPackage.ModelQuality": {
|
|
40203
|
+
"attributes": {},
|
|
40204
|
+
"description": "Model quality statistics and constraints.",
|
|
40205
|
+
"properties": {
|
|
40206
|
+
"Constraints": "Model quality constraints.",
|
|
40207
|
+
"Statistics": "Model quality statistics."
|
|
40208
|
+
}
|
|
40209
|
+
},
|
|
40210
|
+
"AWS::SageMaker::ModelPackage.S3DataSource": {
|
|
40211
|
+
"attributes": {},
|
|
40212
|
+
"description": "Describes the S3 data source.",
|
|
40213
|
+
"properties": {
|
|
40214
|
+
"S3DataType": "If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.\n\nIf you choose `ManifestFile` , `S3Uri` identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.\n\nIf you choose `AugmentedManifestFile` , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. `AugmentedManifestFile` can only be used if the Channel's input mode is `Pipe` .",
|
|
40215
|
+
"S3Uri": "Depending on the value specified for the `S3DataType` , identifies either a key name prefix or a manifest. For example:\n\n- A key name prefix might look like this: `s3://bucketname/exampleprefix`\n- A manifest might look like this: `s3://bucketname/example.manifest`\n\nA manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of `S3Uri` . Note that the prefix must be a valid non-empty `S3Uri` that precludes users from specifying a manifest whose individual `S3Uri` is sourced from different S3 buckets.\n\nThe following code example shows a valid manifest format:\n\n`[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},`\n\n`\"relative/path/to/custdata-1\",`\n\n`\"relative/path/custdata-2\",`\n\n`...`\n\n`\"relative/path/custdata-N\"`\n\n`]`\n\nThis JSON is equivalent to the following `S3Uri` list:\n\n`s3://customer_bucket/some/prefix/relative/path/to/custdata-1`\n\n`s3://customer_bucket/some/prefix/relative/path/custdata-2`\n\n`...`\n\n`s3://customer_bucket/some/prefix/relative/path/custdata-N`\n\nThe complete set of `S3Uri` in this manifest is the input data for the channel for this data source. The object that each `S3Uri` points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf."
|
|
40216
|
+
}
|
|
40217
|
+
},
|
|
40218
|
+
"AWS::SageMaker::ModelPackage.SourceAlgorithm": {
|
|
40219
|
+
"attributes": {},
|
|
40220
|
+
"description": "Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.",
|
|
40221
|
+
"properties": {
|
|
40222
|
+
"AlgorithmName": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.",
|
|
40223
|
+
"ModelDataUrl": "The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single `gzip` compressed tar archive ( `.tar.gz` suffix).\n\n> The model artifacts must be in an S3 bucket that is in the same region as the algorithm."
|
|
40224
|
+
}
|
|
40225
|
+
},
|
|
40226
|
+
"AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification": {
|
|
40227
|
+
"attributes": {},
|
|
40228
|
+
"description": "A list of algorithms that were used to create a model package.",
|
|
40229
|
+
"properties": {
|
|
40230
|
+
"SourceAlgorithms": "A list of the algorithms that were used to create a model package."
|
|
40231
|
+
}
|
|
40232
|
+
},
|
|
40233
|
+
"AWS::SageMaker::ModelPackage.TransformInput": {
|
|
40234
|
+
"attributes": {},
|
|
40235
|
+
"description": "Describes the input source of a transform job and the way the transform job consumes it.",
|
|
40236
|
+
"properties": {
|
|
40237
|
+
"CompressionType": "If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is `None` .",
|
|
40238
|
+
"ContentType": "The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.",
|
|
40239
|
+
"DataSource": "Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.",
|
|
40240
|
+
"SplitType": "The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for `SplitType` is `None` , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to `Line` to split records on a newline character boundary. `SplitType` also supports a number of record-oriented binary data formats. Currently, the supported record formats are:\n\n- RecordIO\n- TFRecord\n\nWhen splitting is enabled, the size of a mini-batch depends on the values of the `BatchStrategy` and `MaxPayloadInMB` parameters. When the value of `BatchStrategy` is `MultiRecord` , Amazon SageMaker sends the maximum number of records in each request, up to the `MaxPayloadInMB` limit. If the value of `BatchStrategy` is `SingleRecord` , Amazon SageMaker sends individual records in each request.\n\n> Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of `BatchStrategy` is set to `SingleRecord` . Padding is not removed if the value of `BatchStrategy` is set to `MultiRecord` .\n> \n> For more information about `RecordIO` , see [Create a Dataset Using RecordIO](https://docs.aws.amazon.com/https://mxnet.apache.org/api/faq/recordio) in the MXNet documentation. For more information about `TFRecord` , see [Consuming TFRecord data](https://docs.aws.amazon.com/https://www.tensorflow.org/guide/data#consuming_tfrecord_data) in the TensorFlow documentation."
|
|
40241
|
+
}
|
|
40242
|
+
},
|
|
40243
|
+
"AWS::SageMaker::ModelPackage.TransformJobDefinition": {
|
|
40244
|
+
"attributes": {},
|
|
40245
|
+
"description": "Defines the input needed to run a transform job using the inference specification specified in the algorithm.",
|
|
40246
|
+
"properties": {
|
|
40247
|
+
"BatchStrategy": "A string that determines the number of records included in a single mini-batch.\n\n`SingleRecord` means only one record is used per mini-batch. `MultiRecord` means a mini-batch is set to contain as many records that can fit within the `MaxPayloadInMB` limit.",
|
|
40248
|
+
"Environment": "The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.",
|
|
40249
|
+
"MaxConcurrentTransforms": "The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.",
|
|
40250
|
+
"MaxPayloadInMB": "The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).",
|
|
40251
|
+
"TransformInput": "A description of the input source and the way the transform job consumes it.",
|
|
40252
|
+
"TransformOutput": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.",
|
|
40253
|
+
"TransformResources": "Identifies the ML compute instances for the transform job."
|
|
40254
|
+
}
|
|
40255
|
+
},
|
|
40256
|
+
"AWS::SageMaker::ModelPackage.TransformOutput": {
|
|
40257
|
+
"attributes": {},
|
|
40258
|
+
"description": "Describes the results of a transform job.",
|
|
40259
|
+
"properties": {
|
|
40260
|
+
"Accept": "The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.",
|
|
40261
|
+
"AssembleWith": "Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify `None` . To add a newline character at the end of every transformed record, specify `Line` .",
|
|
40262
|
+
"KmsKeyId": "The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The `KmsKeyId` can be any of the following formats:\n\n- Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n- Key ARN: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n- Alias name: `alias/ExampleAlias`\n- Alias name ARN: `arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias`\n\nIf you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see [KMS-Managed Encryption Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Developer Guide.*\n\nThe KMS key policy must grant permission to the IAM role that you specify in your [CreateModel](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) request. For more information, see [Using Key Policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the *AWS Key Management Service Developer Guide* .",
|
|
40263
|
+
"S3OutputPath": "The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, `s3://bucket-name/key-name-prefix` .\n\nFor every S3 object used as input for the transform job, batch transform stores the transformed data with an . `out` suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at `s3://bucket-name/input-name-prefix/dataset01/data.csv` , batch transform stores the transformed data at `s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out` . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . `out` file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation."
|
|
40264
|
+
}
|
|
40265
|
+
},
|
|
40266
|
+
"AWS::SageMaker::ModelPackage.TransformResources": {
|
|
40267
|
+
"attributes": {},
|
|
40268
|
+
"description": "Describes the resources, including ML instance types and ML instance count, to use for transform job.",
|
|
40269
|
+
"properties": {
|
|
40270
|
+
"InstanceCount": "The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is `1` .",
|
|
40271
|
+
"InstanceType": "The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or `ml.m5.large` instance types.",
|
|
40272
|
+
"VolumeKmsKeyId": "The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.\n\n> Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a `VolumeKmsKeyId` when using an instance type with local storage.\n> \n> For a list of instance types that support local instance storage, see [Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .\n> \n> For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) . \n\nThe `VolumeKmsKeyId` can be any of the following formats:\n\n- Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n- Key ARN: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n- Alias name: `alias/ExampleAlias`\n- Alias name ARN: `arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias`"
|
|
40273
|
+
}
|
|
40274
|
+
},
|
|
40275
|
+
"AWS::SageMaker::ModelPackage.ValidationProfile": {
|
|
40276
|
+
"attributes": {},
|
|
40277
|
+
"description": "",
|
|
40278
|
+
"properties": {
|
|
40279
|
+
"ProfileName": "",
|
|
40280
|
+
"TransformJobDefinition": ""
|
|
40281
|
+
}
|
|
40282
|
+
},
|
|
40283
|
+
"AWS::SageMaker::ModelPackage.ValidationSpecification": {
|
|
40284
|
+
"attributes": {},
|
|
40285
|
+
"description": "",
|
|
40286
|
+
"properties": {
|
|
40287
|
+
"ValidationProfiles": "",
|
|
40288
|
+
"ValidationRole": ""
|
|
40289
|
+
}
|
|
40290
|
+
},
|
|
39953
40291
|
"AWS::SageMaker::ModelPackageGroup": {
|
|
39954
40292
|
"attributes": {
|
|
39955
40293
|
"CreationTime": "The time when the model group was created.",
|
|
@@ -40366,7 +40704,7 @@
|
|
|
40366
40704
|
"Ref": "`Ref` returns the Domain ID and the user profile name, such as `d-xxxxxxxxxxxx` and `my-user-profile` , respectively.",
|
|
40367
40705
|
"UserProfileArn": "The Amazon Resource Name (ARN) of the user profile, such as `arn:aws:sagemaker:us-west-2:account-id:user-profile/my-user-profile` ."
|
|
40368
40706
|
},
|
|
40369
|
-
"description": "Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.",
|
|
40707
|
+
"description": "Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n\n> If you're using SSO authentication, an SSO user, or an SSO group containing that user, must be assigned to the Amazon SageMaker Studio application from the AWS SSO Console to create a user profile. For more information about application assignment, see [Assign user access](https://docs.aws.amazon.com/singlesignon/latest/userguide/assignuserstoapp.html) . After assignment is complete, a user profile can be created for that SSO user with AWS CloudFormation.",
|
|
40370
40708
|
"properties": {
|
|
40371
40709
|
"DomainId": "The domain ID.",
|
|
40372
40710
|
"SingleSignOnUserIdentifier": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.",
|
|
@@ -41424,7 +41762,7 @@
|
|
|
41424
41762
|
"LoggingRole": "Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.",
|
|
41425
41763
|
"PostAuthenticationLoginBanner": "Specify a string to display when users connect to a server. This string is displayed after the user authenticates.\n\n> The SFTP protocol does not support post-authentication display banners.",
|
|
41426
41764
|
"PreAuthenticationLoginBanner": "Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.\n\n`This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.`",
|
|
41427
|
-
"ProtocolDetails": "The protocol settings that are configured for your server.\n\
|
|
41765
|
+
"ProtocolDetails": "The protocol settings that are configured for your server.\n\n- Use the `PassiveIp` parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n- Use the `SetStatOption` to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Set the value to `ENABLE_NO_OP` to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. Note that with `SetStatOption` set to `ENABLE_NO_OP` , Transfer generates a log entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.\n- Use the `TlsSessionResumptionMode` parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.",
|
|
41428
41766
|
"Protocols": "Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:\n\n- `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH\n- `FTPS` (File Transfer Protocol Secure): File transfer with TLS encryption\n- `FTP` (File Transfer Protocol): Unencrypted file transfer\n\n> If you select `FTPS` , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.\n> \n> If `Protocol` includes either `FTP` or `FTPS` , then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .\n> \n> If `Protocol` includes `FTP` , then `AddressAllocationIds` cannot be associated.\n> \n> If `Protocol` is set only to `SFTP` , the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set to `SERVICE_MANAGED` .",
|
|
41429
41767
|
"SecurityPolicyName": "Specifies the name of the security policy that is attached to the server.",
|
|
41430
41768
|
"Tags": "Key-value pairs that can be used to group and search for servers.",
|
|
@@ -41461,8 +41799,9 @@
|
|
|
41461
41799
|
"attributes": {},
|
|
41462
41800
|
"description": "Protocol settings that are configured for your server.",
|
|
41463
41801
|
"properties": {
|
|
41464
|
-
"PassiveIp": "Indicates passive mode, for FTP and FTPS protocols. Enter a single
|
|
41465
|
-
"
|
|
41802
|
+
"PassiveIp": "Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:\n\n`aws transfer update-server --protocol-details PassiveIp= *0.0.0.0*`\n\nReplace `*0.0.0.0*` in the example above with the actual IP address you want to use.\n\n> If you change the `PassiveIp` value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see [Configuring your FTPS server behind a firewall or NAT with AWS Transfer Family](https://docs.aws.amazon.com/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/) .",
|
|
41803
|
+
"SetStatOption": "Use the `SetStatOption` to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.\n\nSome SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.\n\nSet the value to `ENABLE_NO_OP` to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the `SetStatOption` `ENABLE_NO_OP` setting ignores the error, it does generate a log entry in CloudWatch Logs, so you can determine when the client is making a SETSTAT call.\n\n> If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.",
|
|
41804
|
+
"TlsSessionResumptionMode": "A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. `TlsSessionResumptionMode` determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during `CreateServer` and `UpdateServer` calls. If a `TlsSessionResumptionMode` value is not specified during `CreateServer` , it is set to `ENFORCED` by default.\n\n- `DISABLED` : the server does not process TLS session resumption client requests and creates a new TLS session for each request.\n- `ENABLED` : the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.\n- `ENFORCED` : the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to `ENFORCED` , test your clients.\n\n> Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the `ENFORCED` value, you need to test your clients."
|
|
41466
41805
|
}
|
|
41467
41806
|
},
|
|
41468
41807
|
"AWS::Transfer::Server.WorkflowDetail": {
|
|
@@ -41552,11 +41891,11 @@
|
|
|
41552
41891
|
"DomainId": "The identifier of the domain.",
|
|
41553
41892
|
"Ref": "`Ref` returns the `DomainId` of the domain."
|
|
41554
41893
|
},
|
|
41555
|
-
"description": "Creates a domain that contains all Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.",
|
|
41894
|
+
"description": "Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.",
|
|
41556
41895
|
"properties": {
|
|
41557
41896
|
"Description": "The client-provided description of the domain.",
|
|
41558
41897
|
"Name": "The client-provided name for the domain.",
|
|
41559
|
-
"ServerSideEncryptionConfiguration": "The server-side encryption configuration containing the KMS Key Identifier you want
|
|
41898
|
+
"ServerSideEncryptionConfiguration": "The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.",
|
|
41560
41899
|
"Tags": "The tags used to organize, track, or control access for this resource."
|
|
41561
41900
|
}
|
|
41562
41901
|
},
|
|
@@ -41564,7 +41903,7 @@
|
|
|
41564
41903
|
"attributes": {},
|
|
41565
41904
|
"description": "The configuration containing information about the customer-managed KMS Key used for encrypting customer data.",
|
|
41566
41905
|
"properties": {
|
|
41567
|
-
"KmsKeyId": "The identifier of the KMS Key you want
|
|
41906
|
+
"KmsKeyId": "The identifier of the KMS Key you want Voice ID to use to encrypt your data."
|
|
41568
41907
|
}
|
|
41569
41908
|
},
|
|
41570
41909
|
"AWS::WAF::ByteMatchSet": {
|
|
@@ -42067,7 +42406,7 @@
|
|
|
42067
42406
|
},
|
|
42068
42407
|
"AWS::WAFv2::RuleGroup.ByteMatchStatement": {
|
|
42069
42408
|
"attributes": {},
|
|
42070
|
-
"description": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is
|
|
42409
|
+
"description": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.",
|
|
42071
42410
|
"properties": {
|
|
42072
42411
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42073
42412
|
"PositionalConstraint": "The area within the portion of the web request that you want AWS WAF to search for `SearchString` . Valid values include the following:\n\n*CONTAINS*\n\nThe specified part of the web request must include the value of `SearchString` , but the location doesn't matter.\n\n*CONTAINS_WORD*\n\nThe specified part of the web request must include the value of `SearchString` , and `SearchString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, `SearchString` must be a word, which means that both of the following are true:\n\n- `SearchString` is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and `;BadBot` .\n- `SearchString` is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, `BadBot;` and `-BadBot;` .\n\n*EXACTLY*\n\nThe value of the specified part of the web request must exactly match the value of `SearchString` .\n\n*STARTS_WITH*\n\nThe value of `SearchString` must appear at the beginning of the specified part of the web request.\n\n*ENDS_WITH*\n\nThe value of `SearchString` must appear at the end of the specified part of the web request.",
|
|
@@ -42239,7 +42578,7 @@
|
|
|
42239
42578
|
},
|
|
42240
42579
|
"AWS::WAFv2::RuleGroup.RateBasedStatement": {
|
|
42241
42580
|
"attributes": {},
|
|
42242
|
-
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the
|
|
42581
|
+
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
42243
42582
|
"properties": {
|
|
42244
42583
|
"AggregateKeyType": "Setting that indicates how to aggregate the request counts. The options are the following:\n\n- IP - Aggregate the request counts on the IP address from the web request origin.\n- FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the `ForwardedIPConfig` , to specify the header to use.",
|
|
42245
42584
|
"ForwardedIPConfig": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n\n> If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. \n\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP` .",
|
|
@@ -42290,7 +42629,7 @@
|
|
|
42290
42629
|
},
|
|
42291
42630
|
"AWS::WAFv2::RuleGroup.SizeConstraintStatement": {
|
|
42292
42631
|
"attributes": {},
|
|
42293
|
-
"description": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you
|
|
42632
|
+
"description": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.\n\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.",
|
|
42294
42633
|
"properties": {
|
|
42295
42634
|
"ComparisonOperator": "The operator to use to compare the request part to the size setting.",
|
|
42296
42635
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
@@ -42300,7 +42639,7 @@
|
|
|
42300
42639
|
},
|
|
42301
42640
|
"AWS::WAFv2::RuleGroup.SqliMatchStatement": {
|
|
42302
42641
|
"attributes": {},
|
|
42303
|
-
"description": "
|
|
42642
|
+
"description": "A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.",
|
|
42304
42643
|
"properties": {
|
|
42305
42644
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42306
42645
|
"TextTransformations": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match."
|
|
@@ -42311,18 +42650,18 @@
|
|
|
42311
42650
|
"description": "The processing guidance for a rule, used by AWS WAF to determine whether a web request matches the rule.",
|
|
42312
42651
|
"properties": {
|
|
42313
42652
|
"AndStatement": "A logical rule statement used to combine other rule statements with AND logic. You provide more than one `Statement` within the `AndStatement` .",
|
|
42314
|
-
"ByteMatchStatement": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is
|
|
42653
|
+
"ByteMatchStatement": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.",
|
|
42315
42654
|
"GeoMatchStatement": "A rule statement used to identify web requests based on country of origin.",
|
|
42316
42655
|
"IPSetReferenceStatement": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an `IPSet` that specifies the addresses you want to detect, then use the ARN of that set in this statement.\n\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
42317
42656
|
"LabelMatchStatement": "A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.\n\nThe label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.",
|
|
42318
42657
|
"NotStatement": "A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .",
|
|
42319
42658
|
"OrStatement": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .",
|
|
42320
|
-
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the
|
|
42659
|
+
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
42321
42660
|
"RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression.",
|
|
42322
42661
|
"RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions. To use this, create a `RegexPatternSet` that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set.\n\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
42323
|
-
"SizeConstraintStatement": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you
|
|
42324
|
-
"SqliMatchStatement": "
|
|
42325
|
-
"XssMatchStatement": "A rule statement that
|
|
42662
|
+
"SizeConstraintStatement": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.\n\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.",
|
|
42663
|
+
"SqliMatchStatement": "A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.",
|
|
42664
|
+
"XssMatchStatement": "A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers."
|
|
42326
42665
|
}
|
|
42327
42666
|
},
|
|
42328
42667
|
"AWS::WAFv2::RuleGroup.TextTransformation": {
|
|
@@ -42344,7 +42683,7 @@
|
|
|
42344
42683
|
},
|
|
42345
42684
|
"AWS::WAFv2::RuleGroup.XssMatchStatement": {
|
|
42346
42685
|
"attributes": {},
|
|
42347
|
-
"description": "A rule statement that
|
|
42686
|
+
"description": "A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.",
|
|
42348
42687
|
"properties": {
|
|
42349
42688
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42350
42689
|
"TextTransformations": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match."
|
|
@@ -42401,7 +42740,7 @@
|
|
|
42401
42740
|
},
|
|
42402
42741
|
"AWS::WAFv2::WebACL.ByteMatchStatement": {
|
|
42403
42742
|
"attributes": {},
|
|
42404
|
-
"description": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is
|
|
42743
|
+
"description": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.",
|
|
42405
42744
|
"properties": {
|
|
42406
42745
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42407
42746
|
"PositionalConstraint": "The area within the portion of the web request that you want AWS WAF to search for `SearchString` . Valid values include the following:\n\n*CONTAINS*\n\nThe specified part of the web request must include the value of `SearchString` , but the location doesn't matter.\n\n*CONTAINS_WORD*\n\nThe specified part of the web request must include the value of `SearchString` , and `SearchString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, `SearchString` must be a word, which means that both of the following are true:\n\n- `SearchString` is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and `;BadBot` .\n- `SearchString` is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, `BadBot;` and `-BadBot;` .\n\n*EXACTLY*\n\nThe value of the specified part of the web request must exactly match the value of `SearchString` .\n\n*STARTS_WITH*\n\nThe value of `SearchString` must appear at the beginning of the specified part of the web request.\n\n*ENDS_WITH*\n\nThe value of `SearchString` must appear at the end of the specified part of the web request.",
|
|
@@ -42656,7 +42995,7 @@
|
|
|
42656
42995
|
},
|
|
42657
42996
|
"AWS::WAFv2::WebACL.RateBasedStatement": {
|
|
42658
42997
|
"attributes": {},
|
|
42659
|
-
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the
|
|
42998
|
+
"description": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
42660
42999
|
"properties": {
|
|
42661
43000
|
"AggregateKeyType": "Setting that indicates how to aggregate the request counts. The options are the following:\n\n- IP - Aggregate the request counts on the IP address from the web request origin.\n- FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the `ForwardedIPConfig` , to specify the header to use.",
|
|
42662
43001
|
"ForwardedIPConfig": "The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n\n> If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. \n\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP` .",
|
|
@@ -42716,7 +43055,7 @@
|
|
|
42716
43055
|
},
|
|
42717
43056
|
"AWS::WAFv2::WebACL.SizeConstraintStatement": {
|
|
42718
43057
|
"attributes": {},
|
|
42719
|
-
"description": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you
|
|
43058
|
+
"description": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.\n\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.",
|
|
42720
43059
|
"properties": {
|
|
42721
43060
|
"ComparisonOperator": "The operator to use to compare the request part to the size setting.",
|
|
42722
43061
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
@@ -42726,7 +43065,7 @@
|
|
|
42726
43065
|
},
|
|
42727
43066
|
"AWS::WAFv2::WebACL.SqliMatchStatement": {
|
|
42728
43067
|
"attributes": {},
|
|
42729
|
-
"description": "
|
|
43068
|
+
"description": "A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.",
|
|
42730
43069
|
"properties": {
|
|
42731
43070
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42732
43071
|
"TextTransformations": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match."
|
|
@@ -42737,20 +43076,20 @@
|
|
|
42737
43076
|
"description": "The processing guidance for a rule, used by AWS WAF to determine whether a web request matches the rule.",
|
|
42738
43077
|
"properties": {
|
|
42739
43078
|
"AndStatement": "A logical rule statement used to combine other rule statements with AND logic. You provide more than one `Statement` within the `AndStatement` .",
|
|
42740
|
-
"ByteMatchStatement": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is
|
|
43079
|
+
"ByteMatchStatement": "A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.",
|
|
42741
43080
|
"GeoMatchStatement": "A rule statement used to identify web requests based on country of origin.",
|
|
42742
43081
|
"IPSetReferenceStatement": "A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an `IPSet` that specifies the addresses you want to detect, then use the ARN of that set in this statement.\n\nEach IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
42743
43082
|
"LabelMatchStatement": "A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.\n\nThe label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.",
|
|
42744
43083
|
"ManagedRuleGroupStatement": "A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement.\n\nYou cannot nest a `ManagedRuleGroupStatement` , for example for use inside a `NotStatement` or `OrStatement` . It can only be referenced as a top-level statement within a rule.",
|
|
42745
43084
|
"NotStatement": "A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .",
|
|
42746
43085
|
"OrStatement": "A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .",
|
|
42747
|
-
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the
|
|
43086
|
+
"RateBasedStatement": "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.\n\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .\n\nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.\n\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:\n\n- An IP match statement with an IP set that specified the address 192.0.2.44.\n- A string match statement that searches in the User-Agent header for the string BadBot.\n\nIn this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.\n\nYou cannot nest a `RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement` . You can define a `RateBasedStatement` inside a web ACL and inside a rule group.",
|
|
42748
43087
|
"RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression.",
|
|
42749
43088
|
"RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions. To use this, create a `RegexPatternSet` that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set.\n\nEach regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.",
|
|
42750
43089
|
"RuleGroupReferenceStatement": "A rule statement used to run the rules that are defined in a `RuleGroup` . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.\n\nYou cannot nest a `RuleGroupReferenceStatement` , for example for use inside a `NotStatement` or `OrStatement` . You can only use a rule group reference statement at the top level inside a web ACL.",
|
|
42751
|
-
"SizeConstraintStatement": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you
|
|
42752
|
-
"SqliMatchStatement": "
|
|
42753
|
-
"XssMatchStatement": "A rule statement that
|
|
43090
|
+
"SizeConstraintStatement": "A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.\n\nIf you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.\n\nIf you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.",
|
|
43091
|
+
"SqliMatchStatement": "A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.",
|
|
43092
|
+
"XssMatchStatement": "A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers."
|
|
42754
43093
|
}
|
|
42755
43094
|
},
|
|
42756
43095
|
"AWS::WAFv2::WebACL.TextTransformation": {
|
|
@@ -42772,7 +43111,7 @@
|
|
|
42772
43111
|
},
|
|
42773
43112
|
"AWS::WAFv2::WebACL.XssMatchStatement": {
|
|
42774
43113
|
"attributes": {},
|
|
42775
|
-
"description": "A rule statement that
|
|
43114
|
+
"description": "A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.",
|
|
42776
43115
|
"properties": {
|
|
42777
43116
|
"FieldToMatch": "The part of the web request that you want AWS WAF to inspect.",
|
|
42778
43117
|
"TextTransformations": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match."
|